blob: 53bb3c621010c2c5a6f90c733709dcf2fdd27934 [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
2258 * as a continue state. In practice this means with any of system bar,
2259 * nav bar, and status bar shown, but not the space that would be needed
2260 * for an input method.
2261 *
2262 * <p>If you are using ActionBar in
2263 * overlay mode with {@link Window#FEATURE_ACTION_BAR_OVERLAY
2264 * Window.FEATURE_ACTION_BAR_OVERLAY}, this flag will also impact the
2265 * insets it adds to those given to the application.
2266 */
2267 public static final int SYSTEM_UI_FLAG_LAYOUT_STABLE = 0x00000100;
2268
2269 /**
2270 * Flag for {@link #setSystemUiVisibility(int)}: View would like its window
2271 * to be layed out as if it has requested
2272 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, even if it currently hasn't. This
2273 * allows it to avoid artifacts when switching in and out of that mode, at
2274 * the expense that some of its user interface may be covered by screen
2275 * decorations when they are shown. You can perform layout of your inner
2276 * UI elements to account for the navagation system UI through the
2277 * {@link #fitSystemWindows(Rect)} method.
2278 */
2279 public static final int SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION = 0x00000200;
2280
2281 /**
2282 * Flag for {@link #setSystemUiVisibility(int)}: View would like its window
2283 * to be layed out as if it has requested
2284 * {@link #SYSTEM_UI_FLAG_FULLSCREEN}, even if it currently hasn't. This
2285 * allows it to avoid artifacts when switching in and out of that mode, at
2286 * the expense that some of its user interface may be covered by screen
2287 * decorations when they are shown. You can perform layout of your inner
2288 * UI elements to account for non-fullscreen system UI through the
2289 * {@link #fitSystemWindows(Rect)} method.
2290 */
2291 public static final int SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN = 0x00000400;
2292
2293 /**
Daniel Sandler60ee2562011-07-22 12:34:33 -04002294 * @deprecated Use {@link #SYSTEM_UI_FLAG_LOW_PROFILE} instead.
2295 */
2296 public static final int STATUS_BAR_HIDDEN = SYSTEM_UI_FLAG_LOW_PROFILE;
2297
2298 /**
2299 * @deprecated Use {@link #SYSTEM_UI_FLAG_VISIBLE} instead.
2300 */
2301 public static final int STATUS_BAR_VISIBLE = SYSTEM_UI_FLAG_VISIBLE;
Joe Onorato664644d2011-01-23 17:53:23 -08002302
2303 /**
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002304 * @hide
2305 *
2306 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2307 * out of the public fields to keep the undefined bits out of the developer's way.
2308 *
2309 * Flag to make the status bar not expandable. Unless you also
2310 * set {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS}, new notifications will continue to show.
2311 */
2312 public static final int STATUS_BAR_DISABLE_EXPAND = 0x00010000;
2313
2314 /**
2315 * @hide
2316 *
2317 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2318 * out of the public fields to keep the undefined bits out of the developer's way.
2319 *
2320 * Flag to hide notification icons and scrolling ticker text.
2321 */
2322 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ICONS = 0x00020000;
2323
2324 /**
2325 * @hide
2326 *
2327 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2328 * out of the public fields to keep the undefined bits out of the developer's way.
2329 *
2330 * Flag to disable incoming notification alerts. This will not block
2331 * icons, but it will block sound, vibrating and other visual or aural notifications.
2332 */
2333 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ALERTS = 0x00040000;
2334
2335 /**
2336 * @hide
2337 *
2338 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2339 * out of the public fields to keep the undefined bits out of the developer's way.
2340 *
2341 * Flag to hide only the scrolling ticker. Note that
2342 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS} implies
2343 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_TICKER}.
2344 */
2345 public static final int STATUS_BAR_DISABLE_NOTIFICATION_TICKER = 0x00080000;
2346
2347 /**
2348 * @hide
2349 *
2350 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2351 * out of the public fields to keep the undefined bits out of the developer's way.
2352 *
2353 * Flag to hide the center system info area.
2354 */
2355 public static final int STATUS_BAR_DISABLE_SYSTEM_INFO = 0x00100000;
2356
2357 /**
2358 * @hide
2359 *
2360 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2361 * out of the public fields to keep the undefined bits out of the developer's way.
2362 *
Daniel Sandlerdba93562011-10-06 16:39:58 -04002363 * Flag to hide only the home button. Don't use this
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002364 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
2365 */
Daniel Sandlerdba93562011-10-06 16:39:58 -04002366 public static final int STATUS_BAR_DISABLE_HOME = 0x00200000;
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002367
2368 /**
2369 * @hide
2370 *
2371 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2372 * out of the public fields to keep the undefined bits out of the developer's way.
2373 *
Daniel Sandlerdba93562011-10-06 16:39:58 -04002374 * Flag to hide only the back button. Don't use this
Joe Onorato6478adc2011-01-27 21:15:01 -08002375 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
2376 */
2377 public static final int STATUS_BAR_DISABLE_BACK = 0x00400000;
2378
2379 /**
2380 * @hide
2381 *
2382 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2383 * out of the public fields to keep the undefined bits out of the developer's way.
2384 *
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002385 * Flag to hide only the clock. You might use this if your activity has
2386 * its own clock making the status bar's clock redundant.
2387 */
Joe Onorato6478adc2011-01-27 21:15:01 -08002388 public static final int STATUS_BAR_DISABLE_CLOCK = 0x00800000;
2389
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002390 /**
2391 * @hide
Daniel Sandlerdba93562011-10-06 16:39:58 -04002392 *
2393 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2394 * out of the public fields to keep the undefined bits out of the developer's way.
2395 *
2396 * Flag to hide only the recent apps button. Don't use this
2397 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
2398 */
2399 public static final int STATUS_BAR_DISABLE_RECENT = 0x01000000;
2400
2401 /**
2402 * @hide
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002403 */
Daniel Sandler60ee2562011-07-22 12:34:33 -04002404 public static final int PUBLIC_STATUS_BAR_VISIBILITY_MASK = 0x0000FFFF;
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002405
2406 /**
Dianne Hackborn9a230e02011-10-06 11:51:27 -07002407 * These are the system UI flags that can be cleared by events outside
2408 * of an application. Currently this is just the ability to tap on the
2409 * screen while hiding the navigation bar to have it return.
2410 * @hide
2411 */
2412 public static final int SYSTEM_UI_CLEARABLE_FLAGS =
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002413 SYSTEM_UI_FLAG_LOW_PROFILE | SYSTEM_UI_FLAG_HIDE_NAVIGATION
2414 | SYSTEM_UI_FLAG_FULLSCREEN;
2415
2416 /**
2417 * Flags that can impact the layout in relation to system UI.
2418 */
2419 public static final int SYSTEM_UI_LAYOUT_FLAGS =
2420 SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION
2421 | SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN;
Dianne Hackborn9a230e02011-10-06 11:51:27 -07002422
2423 /**
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07002424 * Find views that render the specified text.
2425 *
2426 * @see #findViewsWithText(ArrayList, CharSequence, int)
2427 */
2428 public static final int FIND_VIEWS_WITH_TEXT = 0x00000001;
2429
2430 /**
2431 * Find find views that contain the specified content description.
2432 *
2433 * @see #findViewsWithText(ArrayList, CharSequence, int)
2434 */
2435 public static final int FIND_VIEWS_WITH_CONTENT_DESCRIPTION = 0x00000002;
2436
2437 /**
Svetoslav Ganov02107852011-10-03 17:06:56 -07002438 * Find views that contain {@link AccessibilityNodeProvider}. Such
2439 * a View is a root of virtual view hierarchy and may contain the searched
2440 * text. If this flag is set Views with providers are automatically
2441 * added and it is a responsibility of the client to call the APIs of
2442 * the provider to determine whether the virtual tree rooted at this View
2443 * contains the text, i.e. getting the list of {@link AccessibilityNodeInfo}s
2444 * represeting the virtual views with this text.
2445 *
2446 * @see #findViewsWithText(ArrayList, CharSequence, int)
2447 *
2448 * @hide
2449 */
2450 public static final int FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS = 0x00000004;
2451
2452 /**
Romain Guybb9908b2012-03-08 11:14:07 -08002453 * Indicates that the screen has changed state and is now off.
2454 *
2455 * @see #onScreenStateChanged(int)
2456 */
2457 public static final int SCREEN_STATE_OFF = 0x0;
2458
2459 /**
2460 * Indicates that the screen has changed state and is now on.
2461 *
Romain Guy1e3d3132012-03-08 15:55:56 -08002462 * @see #onScreenStateChanged(int)
Romain Guybb9908b2012-03-08 11:14:07 -08002463 */
2464 public static final int SCREEN_STATE_ON = 0x1;
2465
2466 /**
Adam Powell637d3372010-08-25 14:37:03 -07002467 * Controls the over-scroll mode for this view.
2468 * See {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)},
2469 * {@link #OVER_SCROLL_ALWAYS}, {@link #OVER_SCROLL_IF_CONTENT_SCROLLS},
2470 * and {@link #OVER_SCROLL_NEVER}.
2471 */
2472 private int mOverScrollMode;
2473
2474 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002475 * The parent this view is attached to.
2476 * {@hide}
2477 *
2478 * @see #getParent()
2479 */
2480 protected ViewParent mParent;
2481
2482 /**
2483 * {@hide}
2484 */
2485 AttachInfo mAttachInfo;
2486
2487 /**
2488 * {@hide}
2489 */
Romain Guy809a7f62009-05-14 15:44:42 -07002490 @ViewDebug.ExportedProperty(flagMapping = {
2491 @ViewDebug.FlagToString(mask = FORCE_LAYOUT, equals = FORCE_LAYOUT,
2492 name = "FORCE_LAYOUT"),
2493 @ViewDebug.FlagToString(mask = LAYOUT_REQUIRED, equals = LAYOUT_REQUIRED,
2494 name = "LAYOUT_REQUIRED"),
2495 @ViewDebug.FlagToString(mask = DRAWING_CACHE_VALID, equals = DRAWING_CACHE_VALID,
Romain Guy5bcdff42009-05-14 21:27:18 -07002496 name = "DRAWING_CACHE_INVALID", outputIf = false),
Romain Guy809a7f62009-05-14 15:44:42 -07002497 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "DRAWN", outputIf = true),
2498 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "NOT_DRAWN", outputIf = false),
2499 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY_OPAQUE, name = "DIRTY_OPAQUE"),
2500 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY, name = "DIRTY")
2501 })
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002502 int mPrivateFlags;
Christopher Tate3d4bf172011-03-28 16:16:46 -07002503 int mPrivateFlags2;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002504
2505 /**
Joe Onorato664644d2011-01-23 17:53:23 -08002506 * This view's request for the visibility of the status bar.
2507 * @hide
2508 */
Daniel Sandler60ee2562011-07-22 12:34:33 -04002509 @ViewDebug.ExportedProperty(flagMapping = {
2510 @ViewDebug.FlagToString(mask = SYSTEM_UI_FLAG_LOW_PROFILE,
2511 equals = SYSTEM_UI_FLAG_LOW_PROFILE,
2512 name = "SYSTEM_UI_FLAG_LOW_PROFILE", outputIf = true),
2513 @ViewDebug.FlagToString(mask = SYSTEM_UI_FLAG_HIDE_NAVIGATION,
2514 equals = SYSTEM_UI_FLAG_HIDE_NAVIGATION,
2515 name = "SYSTEM_UI_FLAG_HIDE_NAVIGATION", outputIf = true),
2516 @ViewDebug.FlagToString(mask = PUBLIC_STATUS_BAR_VISIBILITY_MASK,
2517 equals = SYSTEM_UI_FLAG_VISIBLE,
2518 name = "SYSTEM_UI_FLAG_VISIBLE", outputIf = true)
2519 })
Joe Onorato664644d2011-01-23 17:53:23 -08002520 int mSystemUiVisibility;
2521
2522 /**
Chet Haase563d4f22012-04-18 16:20:08 -07002523 * Reference count for transient state.
2524 * @see #setHasTransientState(boolean)
2525 */
2526 int mTransientStateCount = 0;
2527
2528 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002529 * Count of how many windows this view has been attached to.
2530 */
2531 int mWindowAttachCount;
2532
2533 /**
2534 * The layout parameters associated with this view and used by the parent
2535 * {@link android.view.ViewGroup} to determine how this view should be
2536 * laid out.
2537 * {@hide}
2538 */
2539 protected ViewGroup.LayoutParams mLayoutParams;
2540
2541 /**
2542 * The view flags hold various views states.
2543 * {@hide}
2544 */
2545 @ViewDebug.ExportedProperty
2546 int mViewFlags;
2547
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002548 static class TransformationInfo {
2549 /**
2550 * The transform matrix for the View. This transform is calculated internally
2551 * based on the rotation, scaleX, and scaleY properties. The identity matrix
2552 * is used by default. Do *not* use this variable directly; instead call
2553 * getMatrix(), which will automatically recalculate the matrix if necessary
2554 * to get the correct matrix based on the latest rotation and scale properties.
2555 */
2556 private final Matrix mMatrix = new Matrix();
Chet Haasec3aa3612010-06-17 08:50:37 -07002557
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002558 /**
2559 * The transform matrix for the View. This transform is calculated internally
2560 * based on the rotation, scaleX, and scaleY properties. The identity matrix
2561 * is used by default. Do *not* use this variable directly; instead call
2562 * getInverseMatrix(), which will automatically recalculate the matrix if necessary
2563 * to get the correct matrix based on the latest rotation and scale properties.
2564 */
2565 private Matrix mInverseMatrix;
Chet Haasec3aa3612010-06-17 08:50:37 -07002566
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002567 /**
2568 * An internal variable that tracks whether we need to recalculate the
2569 * transform matrix, based on whether the rotation or scaleX/Y properties
2570 * have changed since the matrix was last calculated.
2571 */
2572 boolean mMatrixDirty = false;
Chet Haasec3aa3612010-06-17 08:50:37 -07002573
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002574 /**
2575 * An internal variable that tracks whether we need to recalculate the
2576 * transform matrix, based on whether the rotation or scaleX/Y properties
2577 * have changed since the matrix was last calculated.
2578 */
2579 private boolean mInverseMatrixDirty = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07002580
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002581 /**
2582 * A variable that tracks whether we need to recalculate the
2583 * transform matrix, based on whether the rotation or scaleX/Y properties
2584 * have changed since the matrix was last calculated. This variable
2585 * is only valid after a call to updateMatrix() or to a function that
2586 * calls it such as getMatrix(), hasIdentityMatrix() and getInverseMatrix().
2587 */
2588 private boolean mMatrixIsIdentity = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07002589
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002590 /**
2591 * The Camera object is used to compute a 3D matrix when rotationX or rotationY are set.
2592 */
2593 private Camera mCamera = null;
Chet Haasefd2b0022010-08-06 13:08:56 -07002594
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002595 /**
2596 * This matrix is used when computing the matrix for 3D rotations.
2597 */
2598 private Matrix matrix3D = null;
Chet Haasefd2b0022010-08-06 13:08:56 -07002599
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002600 /**
2601 * These prev values are used to recalculate a centered pivot point when necessary. The
2602 * pivot point is only used in matrix operations (when rotation, scale, or translation are
2603 * set), so thes values are only used then as well.
2604 */
2605 private int mPrevWidth = -1;
2606 private int mPrevHeight = -1;
Philip Milne6c8ea062012-04-03 17:38:43 -07002607
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002608 /**
2609 * The degrees rotation around the vertical axis through the pivot point.
2610 */
2611 @ViewDebug.ExportedProperty
2612 float mRotationY = 0f;
2613
2614 /**
2615 * The degrees rotation around the horizontal axis through the pivot point.
2616 */
2617 @ViewDebug.ExportedProperty
2618 float mRotationX = 0f;
2619
2620 /**
2621 * The degrees rotation around the pivot point.
2622 */
2623 @ViewDebug.ExportedProperty
2624 float mRotation = 0f;
2625
2626 /**
2627 * The amount of translation of the object away from its left property (post-layout).
2628 */
2629 @ViewDebug.ExportedProperty
2630 float mTranslationX = 0f;
2631
2632 /**
2633 * The amount of translation of the object away from its top property (post-layout).
2634 */
2635 @ViewDebug.ExportedProperty
2636 float mTranslationY = 0f;
2637
2638 /**
2639 * The amount of scale in the x direction around the pivot point. A
2640 * value of 1 means no scaling is applied.
2641 */
2642 @ViewDebug.ExportedProperty
2643 float mScaleX = 1f;
2644
2645 /**
2646 * The amount of scale in the y direction around the pivot point. A
2647 * value of 1 means no scaling is applied.
2648 */
2649 @ViewDebug.ExportedProperty
2650 float mScaleY = 1f;
2651
2652 /**
Chet Haasea33de552012-02-03 16:28:24 -08002653 * The x location of the point around which the view is rotated and scaled.
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002654 */
2655 @ViewDebug.ExportedProperty
2656 float mPivotX = 0f;
2657
2658 /**
Chet Haasea33de552012-02-03 16:28:24 -08002659 * The y location of the point around which the view is rotated and scaled.
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002660 */
2661 @ViewDebug.ExportedProperty
2662 float mPivotY = 0f;
2663
2664 /**
2665 * The opacity of the View. This is a value from 0 to 1, where 0 means
2666 * completely transparent and 1 means completely opaque.
2667 */
2668 @ViewDebug.ExportedProperty
2669 float mAlpha = 1f;
2670 }
2671
2672 TransformationInfo mTransformationInfo;
Chet Haasefd2b0022010-08-06 13:08:56 -07002673
Joe Malin32736f02011-01-19 16:14:20 -08002674 private boolean mLastIsOpaque;
2675
Chet Haasefd2b0022010-08-06 13:08:56 -07002676 /**
2677 * Convenience value to check for float values that are close enough to zero to be considered
2678 * zero.
2679 */
Romain Guy2542d192010-08-18 11:47:12 -07002680 private static final float NONZERO_EPSILON = .001f;
Chet Haasefd2b0022010-08-06 13:08:56 -07002681
2682 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002683 * The distance in pixels from the left edge of this view's parent
2684 * to the left edge of this view.
2685 * {@hide}
2686 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002687 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002688 protected int mLeft;
2689 /**
2690 * The distance in pixels from the left edge of this view's parent
2691 * to the right edge of this view.
2692 * {@hide}
2693 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002694 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002695 protected int mRight;
2696 /**
2697 * The distance in pixels from the top edge of this view's parent
2698 * to the top edge of this view.
2699 * {@hide}
2700 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002701 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002702 protected int mTop;
2703 /**
2704 * The distance in pixels from the top edge of this view's parent
2705 * to the bottom edge of this view.
2706 * {@hide}
2707 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002708 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002709 protected int mBottom;
2710
2711 /**
2712 * The offset, in pixels, by which the content of this view is scrolled
2713 * horizontally.
2714 * {@hide}
2715 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002716 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002717 protected int mScrollX;
2718 /**
2719 * The offset, in pixels, by which the content of this view is scrolled
2720 * vertically.
2721 * {@hide}
2722 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002723 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002724 protected int mScrollY;
2725
2726 /**
2727 * The left padding in pixels, that is the distance in pixels between the
2728 * left edge of this view and the left edge of its content.
2729 * {@hide}
2730 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002731 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002732 protected int mPaddingLeft;
2733 /**
2734 * The right padding in pixels, that is the distance in pixels between the
2735 * right edge of this view and the right edge of its content.
2736 * {@hide}
2737 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002738 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002739 protected int mPaddingRight;
2740 /**
2741 * The top padding in pixels, that is the distance in pixels between the
2742 * top edge of this view and the top edge of its content.
2743 * {@hide}
2744 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002745 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002746 protected int mPaddingTop;
2747 /**
2748 * The bottom padding in pixels, that is the distance in pixels between the
2749 * bottom edge of this view and the bottom edge of its content.
2750 * {@hide}
2751 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002752 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002753 protected int mPaddingBottom;
2754
2755 /**
Philip Milne1557fd72012-04-04 23:41:34 -07002756 * The layout insets in pixels, that is the distance in pixels between the
2757 * visible edges of this view its bounds.
2758 */
2759 private Insets mLayoutInsets;
2760
2761 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07002762 * Briefly describes the view and is primarily used for accessibility support.
2763 */
2764 private CharSequence mContentDescription;
2765
2766 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002767 * Cache the paddingRight set by the user to append to the scrollbar's size.
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002768 *
2769 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002770 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002771 @ViewDebug.ExportedProperty(category = "padding")
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002772 protected int mUserPaddingRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002773
2774 /**
2775 * Cache the paddingBottom set by the user to append to the scrollbar's size.
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002776 *
2777 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002778 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002779 @ViewDebug.ExportedProperty(category = "padding")
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002780 protected int mUserPaddingBottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002781
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002782 /**
Adam Powell20232d02010-12-08 21:08:53 -08002783 * Cache the paddingLeft set by the user to append to the scrollbar's size.
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002784 *
2785 * @hide
Adam Powell20232d02010-12-08 21:08:53 -08002786 */
2787 @ViewDebug.ExportedProperty(category = "padding")
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002788 protected int mUserPaddingLeft;
Adam Powell20232d02010-12-08 21:08:53 -08002789
2790 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07002791 * Cache if the user padding is relative.
2792 *
2793 */
2794 @ViewDebug.ExportedProperty(category = "padding")
2795 boolean mUserPaddingRelative;
2796
2797 /**
2798 * Cache the paddingStart set by the user to append to the scrollbar's size.
2799 *
2800 */
2801 @ViewDebug.ExportedProperty(category = "padding")
2802 int mUserPaddingStart;
2803
2804 /**
2805 * Cache the paddingEnd set by the user to append to the scrollbar's size.
2806 *
2807 */
2808 @ViewDebug.ExportedProperty(category = "padding")
2809 int mUserPaddingEnd;
2810
2811 /**
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002812 * @hide
2813 */
2814 int mOldWidthMeasureSpec = Integer.MIN_VALUE;
2815 /**
2816 * @hide
2817 */
2818 int mOldHeightMeasureSpec = Integer.MIN_VALUE;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002819
Philip Milne6c8ea062012-04-03 17:38:43 -07002820 private Drawable mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002821
2822 private int mBackgroundResource;
2823 private boolean mBackgroundSizeChanged;
2824
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002825 static class ListenerInfo {
2826 /**
2827 * Listener used to dispatch focus change events.
2828 * This field should be made private, so it is hidden from the SDK.
2829 * {@hide}
2830 */
2831 protected OnFocusChangeListener mOnFocusChangeListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002832
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002833 /**
2834 * Listeners for layout change events.
2835 */
2836 private ArrayList<OnLayoutChangeListener> mOnLayoutChangeListeners;
Chet Haase21cd1382010-09-01 17:42:29 -07002837
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002838 /**
2839 * Listeners for attach events.
2840 */
2841 private CopyOnWriteArrayList<OnAttachStateChangeListener> mOnAttachStateChangeListeners;
Adam Powell4afd62b2011-02-18 15:02:18 -08002842
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002843 /**
2844 * Listener used to dispatch click events.
2845 * This field should be made private, so it is hidden from the SDK.
2846 * {@hide}
2847 */
2848 public OnClickListener mOnClickListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002849
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002850 /**
2851 * Listener used to dispatch long click events.
2852 * This field should be made private, so it is hidden from the SDK.
2853 * {@hide}
2854 */
2855 protected OnLongClickListener mOnLongClickListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002856
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002857 /**
2858 * Listener used to build the context menu.
2859 * This field should be made private, so it is hidden from the SDK.
2860 * {@hide}
2861 */
2862 protected OnCreateContextMenuListener mOnCreateContextMenuListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002863
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002864 private OnKeyListener mOnKeyListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002865
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002866 private OnTouchListener mOnTouchListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002867
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002868 private OnHoverListener mOnHoverListener;
Jeff Brown10b62902011-06-20 16:40:37 -07002869
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002870 private OnGenericMotionListener mOnGenericMotionListener;
Jeff Brown33bbfd22011-02-24 20:55:35 -08002871
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002872 private OnDragListener mOnDragListener;
Chris Tate32affef2010-10-18 15:29:21 -07002873
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002874 private OnSystemUiVisibilityChangeListener mOnSystemUiVisibilityChangeListener;
2875 }
2876
2877 ListenerInfo mListenerInfo;
Joe Onorato664644d2011-01-23 17:53:23 -08002878
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002879 /**
2880 * The application environment this view lives in.
2881 * This field should be made private, so it is hidden from the SDK.
2882 * {@hide}
2883 */
2884 protected Context mContext;
2885
Dianne Hackbornab0f4852011-09-12 16:59:06 -07002886 private final Resources mResources;
2887
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002888 private ScrollabilityCache mScrollCache;
2889
2890 private int[] mDrawableState = null;
2891
Romain Guy0211a0a2011-02-14 16:34:59 -08002892 /**
2893 * Set to true when drawing cache is enabled and cannot be created.
Philip Milne6c8ea062012-04-03 17:38:43 -07002894 *
Romain Guy0211a0a2011-02-14 16:34:59 -08002895 * @hide
2896 */
2897 public boolean mCachingFailed;
2898
Romain Guy02890fd2010-08-06 17:58:44 -07002899 private Bitmap mDrawingCache;
2900 private Bitmap mUnscaledDrawingCache;
Romain Guy6c319ca2011-01-11 14:29:25 -08002901 private HardwareLayer mHardwareLayer;
Romain Guy65b345f2011-07-27 18:51:50 -07002902 DisplayList mDisplayList;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002903
2904 /**
2905 * When this view has focus and the next focus is {@link #FOCUS_LEFT},
2906 * the user may specify which view to go to next.
2907 */
2908 private int mNextFocusLeftId = View.NO_ID;
2909
2910 /**
2911 * When this view has focus and the next focus is {@link #FOCUS_RIGHT},
2912 * the user may specify which view to go to next.
2913 */
2914 private int mNextFocusRightId = View.NO_ID;
2915
2916 /**
2917 * When this view has focus and the next focus is {@link #FOCUS_UP},
2918 * the user may specify which view to go to next.
2919 */
2920 private int mNextFocusUpId = View.NO_ID;
2921
2922 /**
2923 * When this view has focus and the next focus is {@link #FOCUS_DOWN},
2924 * the user may specify which view to go to next.
2925 */
2926 private int mNextFocusDownId = View.NO_ID;
2927
Jeff Brown4e6319b2010-12-13 10:36:51 -08002928 /**
2929 * When this view has focus and the next focus is {@link #FOCUS_FORWARD},
2930 * the user may specify which view to go to next.
2931 */
2932 int mNextFocusForwardId = View.NO_ID;
2933
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002934 private CheckForLongPress mPendingCheckForLongPress;
Adam Powelle14579b2009-12-16 18:39:52 -08002935 private CheckForTap mPendingCheckForTap = null;
Adam Powella35d7682010-03-12 14:48:13 -08002936 private PerformClick mPerformClick;
Svetoslav Ganova0156172011-06-26 17:55:44 -07002937 private SendViewScrolledAccessibilityEvent mSendViewScrolledAccessibilityEvent;
Joe Malin32736f02011-01-19 16:14:20 -08002938
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002939 private UnsetPressedState mUnsetPressedState;
2940
2941 /**
2942 * Whether the long press's action has been invoked. The tap's action is invoked on the
2943 * up event while a long press is invoked as soon as the long press duration is reached, so
2944 * a long press could be performed before the tap is checked, in which case the tap's action
2945 * should not be invoked.
2946 */
2947 private boolean mHasPerformedLongPress;
2948
2949 /**
2950 * The minimum height of the view. We'll try our best to have the height
2951 * of this view to at least this amount.
2952 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002953 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002954 private int mMinHeight;
2955
2956 /**
2957 * The minimum width of the view. We'll try our best to have the width
2958 * of this view to at least this amount.
2959 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002960 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002961 private int mMinWidth;
2962
2963 /**
2964 * The delegate to handle touch events that are physically in this view
2965 * but should be handled by another view.
2966 */
2967 private TouchDelegate mTouchDelegate = null;
2968
2969 /**
2970 * Solid color to use as a background when creating the drawing cache. Enables
2971 * the cache to use 16 bit bitmaps instead of 32 bit.
2972 */
2973 private int mDrawingCacheBackgroundColor = 0;
2974
2975 /**
2976 * Special tree observer used when mAttachInfo is null.
2977 */
2978 private ViewTreeObserver mFloatingTreeObserver;
Joe Malin32736f02011-01-19 16:14:20 -08002979
Adam Powelle14579b2009-12-16 18:39:52 -08002980 /**
2981 * Cache the touch slop from the context that created the view.
2982 */
2983 private int mTouchSlop;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002984
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002985 /**
Chet Haasea00f3862011-02-22 06:34:40 -08002986 * Object that handles automatic animation of view properties.
2987 */
2988 private ViewPropertyAnimator mAnimator = null;
2989
2990 /**
Christopher Tate251602f2011-01-28 17:54:12 -08002991 * Flag indicating that a drag can cross window boundaries. When
2992 * {@link #startDrag(ClipData, DragShadowBuilder, Object, int)} is called
2993 * with this flag set, all visible applications will be able to participate
2994 * in the drag operation and receive the dragged content.
Christopher Tate7f9ff9d2011-02-14 17:31:13 -08002995 *
2996 * @hide
Christopher Tate02d2b3b2011-01-10 20:43:53 -08002997 */
2998 public static final int DRAG_FLAG_GLOBAL = 1;
2999
3000 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08003001 * Vertical scroll factor cached by {@link #getVerticalScrollFactor}.
3002 */
3003 private float mVerticalScrollFactor;
3004
3005 /**
Adam Powell20232d02010-12-08 21:08:53 -08003006 * Position of the vertical scroll bar.
3007 */
3008 private int mVerticalScrollbarPosition;
3009
3010 /**
3011 * Position the scroll bar at the default position as determined by the system.
3012 */
3013 public static final int SCROLLBAR_POSITION_DEFAULT = 0;
3014
3015 /**
3016 * Position the scroll bar along the left edge.
3017 */
3018 public static final int SCROLLBAR_POSITION_LEFT = 1;
3019
3020 /**
3021 * Position the scroll bar along the right edge.
3022 */
3023 public static final int SCROLLBAR_POSITION_RIGHT = 2;
3024
3025 /**
Romain Guy171c5922011-01-06 10:04:23 -08003026 * Indicates that the view does not have a layer.
Joe Malin32736f02011-01-19 16:14:20 -08003027 *
3028 * @see #getLayerType()
3029 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy171c5922011-01-06 10:04:23 -08003030 * @see #LAYER_TYPE_SOFTWARE
Joe Malin32736f02011-01-19 16:14:20 -08003031 * @see #LAYER_TYPE_HARDWARE
Romain Guy171c5922011-01-06 10:04:23 -08003032 */
3033 public static final int LAYER_TYPE_NONE = 0;
3034
3035 /**
3036 * <p>Indicates that the view has a software layer. A software layer is backed
3037 * by a bitmap and causes the view to be rendered using Android's software
3038 * rendering pipeline, even if hardware acceleration is enabled.</p>
Joe Malin32736f02011-01-19 16:14:20 -08003039 *
Romain Guy171c5922011-01-06 10:04:23 -08003040 * <p>Software layers have various usages:</p>
3041 * <p>When the application is not using hardware acceleration, a software layer
3042 * is useful to apply a specific color filter and/or blending mode and/or
3043 * translucency to a view and all its children.</p>
3044 * <p>When the application is using hardware acceleration, a software layer
3045 * is useful to render drawing primitives not supported by the hardware
3046 * accelerated pipeline. It can also be used to cache a complex view tree
3047 * into a texture and reduce the complexity of drawing operations. For instance,
3048 * when animating a complex view tree with a translation, a software layer can
3049 * be used to render the view tree only once.</p>
3050 * <p>Software layers should be avoided when the affected view tree updates
3051 * often. Every update will require to re-render the software layer, which can
3052 * potentially be slow (particularly when hardware acceleration is turned on
3053 * since the layer will have to be uploaded into a hardware texture after every
3054 * update.)</p>
Joe Malin32736f02011-01-19 16:14:20 -08003055 *
3056 * @see #getLayerType()
3057 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy171c5922011-01-06 10:04:23 -08003058 * @see #LAYER_TYPE_NONE
Joe Malin32736f02011-01-19 16:14:20 -08003059 * @see #LAYER_TYPE_HARDWARE
Romain Guy171c5922011-01-06 10:04:23 -08003060 */
3061 public static final int LAYER_TYPE_SOFTWARE = 1;
3062
3063 /**
3064 * <p>Indicates that the view has a hardware layer. A hardware layer is backed
3065 * by a hardware specific texture (generally Frame Buffer Objects or FBO on
3066 * OpenGL hardware) and causes the view to be rendered using Android's hardware
3067 * rendering pipeline, but only if hardware acceleration is turned on for the
3068 * view hierarchy. When hardware acceleration is turned off, hardware layers
3069 * behave exactly as {@link #LAYER_TYPE_SOFTWARE software layers}.</p>
Joe Malin32736f02011-01-19 16:14:20 -08003070 *
Romain Guy171c5922011-01-06 10:04:23 -08003071 * <p>A hardware layer is useful to apply a specific color filter and/or
3072 * blending mode and/or translucency to a view and all its children.</p>
Romain Guy6c319ca2011-01-11 14:29:25 -08003073 * <p>A hardware layer can be used to cache a complex view tree into a
3074 * texture and reduce the complexity of drawing operations. For instance,
3075 * when animating a complex view tree with a translation, a hardware layer can
3076 * be used to render the view tree only once.</p>
Romain Guy171c5922011-01-06 10:04:23 -08003077 * <p>A hardware layer can also be used to increase the rendering quality when
3078 * rotation transformations are applied on a view. It can also be used to
3079 * prevent potential clipping issues when applying 3D transforms on a view.</p>
Joe Malin32736f02011-01-19 16:14:20 -08003080 *
3081 * @see #getLayerType()
Romain Guy171c5922011-01-06 10:04:23 -08003082 * @see #setLayerType(int, android.graphics.Paint)
3083 * @see #LAYER_TYPE_NONE
3084 * @see #LAYER_TYPE_SOFTWARE
3085 */
3086 public static final int LAYER_TYPE_HARDWARE = 2;
Joe Malin32736f02011-01-19 16:14:20 -08003087
Romain Guy3aaff3a2011-01-12 14:18:47 -08003088 @ViewDebug.ExportedProperty(category = "drawing", mapping = {
3089 @ViewDebug.IntToString(from = LAYER_TYPE_NONE, to = "NONE"),
3090 @ViewDebug.IntToString(from = LAYER_TYPE_SOFTWARE, to = "SOFTWARE"),
3091 @ViewDebug.IntToString(from = LAYER_TYPE_HARDWARE, to = "HARDWARE")
3092 })
Romain Guy171c5922011-01-06 10:04:23 -08003093 int mLayerType = LAYER_TYPE_NONE;
3094 Paint mLayerPaint;
Romain Guy3a3133d2011-02-01 22:59:58 -08003095 Rect mLocalDirtyRect;
Romain Guy171c5922011-01-06 10:04:23 -08003096
3097 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07003098 * Set to true when the view is sending hover accessibility events because it
3099 * is the innermost hovered view.
3100 */
3101 private boolean mSendingHoverAccessibilityEvents;
3102
3103 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003104 * Simple constructor to use when creating a view from code.
3105 *
3106 * @param context The Context the view is running in, through which it can
3107 * access the current theme, resources, etc.
3108 */
3109 public View(Context context) {
3110 mContext = context;
3111 mResources = context != null ? context.getResources() : null;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07003112 mViewFlags = SOUND_EFFECTS_ENABLED | HAPTIC_FEEDBACK_ENABLED;
Fabrice Di Megliob934db72012-03-20 14:33:01 -07003113 // Set layout and text direction defaults
3114 mPrivateFlags2 = (LAYOUT_DIRECTION_DEFAULT << LAYOUT_DIRECTION_MASK_SHIFT) |
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07003115 (TEXT_DIRECTION_DEFAULT << TEXT_DIRECTION_MASK_SHIFT) |
Svetoslav Ganov42138042012-03-20 11:51:39 -07003116 (TEXT_ALIGNMENT_DEFAULT << TEXT_ALIGNMENT_MASK_SHIFT) |
3117 (IMPORTANT_FOR_ACCESSIBILITY_DEFAULT << IMPORTANT_FOR_ACCESSIBILITY_SHIFT);
Adam Powelle14579b2009-12-16 18:39:52 -08003118 mTouchSlop = ViewConfiguration.get(context).getScaledTouchSlop();
Adam Powell637d3372010-08-25 14:37:03 -07003119 setOverScrollMode(OVER_SCROLL_IF_CONTENT_SCROLLS);
Fabrice Di Megliof9e36502011-06-21 18:41:48 -07003120 mUserPaddingStart = -1;
3121 mUserPaddingEnd = -1;
3122 mUserPaddingRelative = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003123 }
3124
3125 /**
Chet Haasedb8c9a62012-03-21 18:54:18 -07003126 * Delegate for injecting accessiblity functionality.
3127 */
3128 AccessibilityDelegate mAccessibilityDelegate;
3129
3130 /**
3131 * Consistency verifier for debugging purposes.
3132 * @hide
3133 */
3134 protected final InputEventConsistencyVerifier mInputEventConsistencyVerifier =
3135 InputEventConsistencyVerifier.isInstrumentationEnabled() ?
3136 new InputEventConsistencyVerifier(this, 0) : null;
3137
3138 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003139 * Constructor that is called when inflating a view from XML. This is called
3140 * when a view is being constructed from an XML file, supplying attributes
3141 * that were specified in the XML file. This version uses a default style of
3142 * 0, so the only attribute values applied are those in the Context's Theme
3143 * and the given AttributeSet.
3144 *
3145 * <p>
3146 * The method onFinishInflate() will be called after all children have been
3147 * added.
3148 *
3149 * @param context The Context the view is running in, through which it can
3150 * access the current theme, resources, etc.
3151 * @param attrs The attributes of the XML tag that is inflating the view.
3152 * @see #View(Context, AttributeSet, int)
3153 */
3154 public View(Context context, AttributeSet attrs) {
3155 this(context, attrs, 0);
3156 }
3157
3158 /**
3159 * Perform inflation from XML and apply a class-specific base style. This
3160 * constructor of View allows subclasses to use their own base style when
3161 * they are inflating. For example, a Button class's constructor would call
3162 * this version of the super class constructor and supply
3163 * <code>R.attr.buttonStyle</code> for <var>defStyle</var>; this allows
3164 * the theme's button style to modify all of the base view attributes (in
3165 * particular its background) as well as the Button class's attributes.
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 * @param defStyle The default style to apply to this view. If 0, no style
3171 * will be applied (beyond what is included in the theme). This may
3172 * either be an attribute resource, whose value will be retrieved
3173 * from the current theme, or an explicit style resource.
3174 * @see #View(Context, AttributeSet)
3175 */
3176 public View(Context context, AttributeSet attrs, int defStyle) {
3177 this(context);
3178
3179 TypedArray a = context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.View,
3180 defStyle, 0);
3181
3182 Drawable background = null;
3183
3184 int leftPadding = -1;
3185 int topPadding = -1;
3186 int rightPadding = -1;
3187 int bottomPadding = -1;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003188 int startPadding = -1;
3189 int endPadding = -1;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003190
3191 int padding = -1;
3192
3193 int viewFlagValues = 0;
3194 int viewFlagMasks = 0;
3195
3196 boolean setScrollContainer = false;
Romain Guy8506ab42009-06-11 17:35:47 -07003197
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003198 int x = 0;
3199 int y = 0;
3200
Chet Haase73066682010-11-29 15:55:32 -08003201 float tx = 0;
3202 float ty = 0;
3203 float rotation = 0;
3204 float rotationX = 0;
3205 float rotationY = 0;
3206 float sx = 1f;
3207 float sy = 1f;
3208 boolean transformSet = false;
3209
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003210 int scrollbarStyle = SCROLLBARS_INSIDE_OVERLAY;
3211
Adam Powell637d3372010-08-25 14:37:03 -07003212 int overScrollMode = mOverScrollMode;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003213 final int N = a.getIndexCount();
3214 for (int i = 0; i < N; i++) {
3215 int attr = a.getIndex(i);
3216 switch (attr) {
3217 case com.android.internal.R.styleable.View_background:
3218 background = a.getDrawable(attr);
3219 break;
3220 case com.android.internal.R.styleable.View_padding:
3221 padding = a.getDimensionPixelSize(attr, -1);
3222 break;
3223 case com.android.internal.R.styleable.View_paddingLeft:
3224 leftPadding = a.getDimensionPixelSize(attr, -1);
3225 break;
3226 case com.android.internal.R.styleable.View_paddingTop:
3227 topPadding = a.getDimensionPixelSize(attr, -1);
3228 break;
3229 case com.android.internal.R.styleable.View_paddingRight:
3230 rightPadding = a.getDimensionPixelSize(attr, -1);
3231 break;
3232 case com.android.internal.R.styleable.View_paddingBottom:
3233 bottomPadding = a.getDimensionPixelSize(attr, -1);
3234 break;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003235 case com.android.internal.R.styleable.View_paddingStart:
3236 startPadding = a.getDimensionPixelSize(attr, -1);
3237 break;
3238 case com.android.internal.R.styleable.View_paddingEnd:
3239 endPadding = a.getDimensionPixelSize(attr, -1);
3240 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003241 case com.android.internal.R.styleable.View_scrollX:
3242 x = a.getDimensionPixelOffset(attr, 0);
3243 break;
3244 case com.android.internal.R.styleable.View_scrollY:
3245 y = a.getDimensionPixelOffset(attr, 0);
3246 break;
Chet Haase73066682010-11-29 15:55:32 -08003247 case com.android.internal.R.styleable.View_alpha:
3248 setAlpha(a.getFloat(attr, 1f));
3249 break;
3250 case com.android.internal.R.styleable.View_transformPivotX:
3251 setPivotX(a.getDimensionPixelOffset(attr, 0));
3252 break;
3253 case com.android.internal.R.styleable.View_transformPivotY:
3254 setPivotY(a.getDimensionPixelOffset(attr, 0));
3255 break;
3256 case com.android.internal.R.styleable.View_translationX:
3257 tx = a.getDimensionPixelOffset(attr, 0);
3258 transformSet = true;
3259 break;
3260 case com.android.internal.R.styleable.View_translationY:
3261 ty = a.getDimensionPixelOffset(attr, 0);
3262 transformSet = true;
3263 break;
3264 case com.android.internal.R.styleable.View_rotation:
3265 rotation = a.getFloat(attr, 0);
3266 transformSet = true;
3267 break;
3268 case com.android.internal.R.styleable.View_rotationX:
3269 rotationX = a.getFloat(attr, 0);
3270 transformSet = true;
3271 break;
3272 case com.android.internal.R.styleable.View_rotationY:
3273 rotationY = a.getFloat(attr, 0);
3274 transformSet = true;
3275 break;
3276 case com.android.internal.R.styleable.View_scaleX:
3277 sx = a.getFloat(attr, 1f);
3278 transformSet = true;
3279 break;
3280 case com.android.internal.R.styleable.View_scaleY:
3281 sy = a.getFloat(attr, 1f);
3282 transformSet = true;
3283 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003284 case com.android.internal.R.styleable.View_id:
3285 mID = a.getResourceId(attr, NO_ID);
3286 break;
3287 case com.android.internal.R.styleable.View_tag:
3288 mTag = a.getText(attr);
3289 break;
3290 case com.android.internal.R.styleable.View_fitsSystemWindows:
3291 if (a.getBoolean(attr, false)) {
3292 viewFlagValues |= FITS_SYSTEM_WINDOWS;
3293 viewFlagMasks |= FITS_SYSTEM_WINDOWS;
3294 }
3295 break;
3296 case com.android.internal.R.styleable.View_focusable:
3297 if (a.getBoolean(attr, false)) {
3298 viewFlagValues |= FOCUSABLE;
3299 viewFlagMasks |= FOCUSABLE_MASK;
3300 }
3301 break;
3302 case com.android.internal.R.styleable.View_focusableInTouchMode:
3303 if (a.getBoolean(attr, false)) {
3304 viewFlagValues |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE;
3305 viewFlagMasks |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE_MASK;
3306 }
3307 break;
3308 case com.android.internal.R.styleable.View_clickable:
3309 if (a.getBoolean(attr, false)) {
3310 viewFlagValues |= CLICKABLE;
3311 viewFlagMasks |= CLICKABLE;
3312 }
3313 break;
3314 case com.android.internal.R.styleable.View_longClickable:
3315 if (a.getBoolean(attr, false)) {
3316 viewFlagValues |= LONG_CLICKABLE;
3317 viewFlagMasks |= LONG_CLICKABLE;
3318 }
3319 break;
3320 case com.android.internal.R.styleable.View_saveEnabled:
3321 if (!a.getBoolean(attr, true)) {
3322 viewFlagValues |= SAVE_DISABLED;
3323 viewFlagMasks |= SAVE_DISABLED_MASK;
3324 }
3325 break;
3326 case com.android.internal.R.styleable.View_duplicateParentState:
3327 if (a.getBoolean(attr, false)) {
3328 viewFlagValues |= DUPLICATE_PARENT_STATE;
3329 viewFlagMasks |= DUPLICATE_PARENT_STATE;
3330 }
3331 break;
3332 case com.android.internal.R.styleable.View_visibility:
3333 final int visibility = a.getInt(attr, 0);
3334 if (visibility != 0) {
3335 viewFlagValues |= VISIBILITY_FLAGS[visibility];
3336 viewFlagMasks |= VISIBILITY_MASK;
3337 }
3338 break;
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07003339 case com.android.internal.R.styleable.View_layoutDirection:
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07003340 // Clear any layout direction flags (included resolved bits) already set
3341 mPrivateFlags2 &= ~(LAYOUT_DIRECTION_MASK | LAYOUT_DIRECTION_RESOLVED_MASK);
3342 // Set the layout direction flags depending on the value of the attribute
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07003343 final int layoutDirection = a.getInt(attr, -1);
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07003344 final int value = (layoutDirection != -1) ?
3345 LAYOUT_DIRECTION_FLAGS[layoutDirection] : LAYOUT_DIRECTION_DEFAULT;
3346 mPrivateFlags2 |= (value << LAYOUT_DIRECTION_MASK_SHIFT);
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07003347 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003348 case com.android.internal.R.styleable.View_drawingCacheQuality:
3349 final int cacheQuality = a.getInt(attr, 0);
3350 if (cacheQuality != 0) {
3351 viewFlagValues |= DRAWING_CACHE_QUALITY_FLAGS[cacheQuality];
3352 viewFlagMasks |= DRAWING_CACHE_QUALITY_MASK;
3353 }
3354 break;
svetoslavganov75986cf2009-05-14 22:28:01 -07003355 case com.android.internal.R.styleable.View_contentDescription:
3356 mContentDescription = a.getString(attr);
3357 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003358 case com.android.internal.R.styleable.View_soundEffectsEnabled:
3359 if (!a.getBoolean(attr, true)) {
3360 viewFlagValues &= ~SOUND_EFFECTS_ENABLED;
3361 viewFlagMasks |= SOUND_EFFECTS_ENABLED;
3362 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07003363 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003364 case com.android.internal.R.styleable.View_hapticFeedbackEnabled:
3365 if (!a.getBoolean(attr, true)) {
3366 viewFlagValues &= ~HAPTIC_FEEDBACK_ENABLED;
3367 viewFlagMasks |= HAPTIC_FEEDBACK_ENABLED;
3368 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07003369 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003370 case R.styleable.View_scrollbars:
3371 final int scrollbars = a.getInt(attr, SCROLLBARS_NONE);
3372 if (scrollbars != SCROLLBARS_NONE) {
3373 viewFlagValues |= scrollbars;
3374 viewFlagMasks |= SCROLLBARS_MASK;
3375 initializeScrollbars(a);
3376 }
3377 break;
Romain Guy2a9fa892011-09-28 16:50:02 -07003378 //noinspection deprecation
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003379 case R.styleable.View_fadingEdge:
Romain Guy1ef3fdb2011-09-09 15:30:30 -07003380 if (context.getApplicationInfo().targetSdkVersion >= ICE_CREAM_SANDWICH) {
3381 // Ignore the attribute starting with ICS
3382 break;
3383 }
3384 // With builds < ICS, fall through and apply fading edges
3385 case R.styleable.View_requiresFadingEdge:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003386 final int fadingEdge = a.getInt(attr, FADING_EDGE_NONE);
3387 if (fadingEdge != FADING_EDGE_NONE) {
3388 viewFlagValues |= fadingEdge;
3389 viewFlagMasks |= FADING_EDGE_MASK;
3390 initializeFadingEdge(a);
3391 }
3392 break;
3393 case R.styleable.View_scrollbarStyle:
3394 scrollbarStyle = a.getInt(attr, SCROLLBARS_INSIDE_OVERLAY);
3395 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
3396 viewFlagValues |= scrollbarStyle & SCROLLBARS_STYLE_MASK;
3397 viewFlagMasks |= SCROLLBARS_STYLE_MASK;
3398 }
3399 break;
3400 case R.styleable.View_isScrollContainer:
3401 setScrollContainer = true;
3402 if (a.getBoolean(attr, false)) {
3403 setScrollContainer(true);
3404 }
3405 break;
3406 case com.android.internal.R.styleable.View_keepScreenOn:
3407 if (a.getBoolean(attr, false)) {
3408 viewFlagValues |= KEEP_SCREEN_ON;
3409 viewFlagMasks |= KEEP_SCREEN_ON;
3410 }
3411 break;
Jeff Brown85a31762010-09-01 17:01:00 -07003412 case R.styleable.View_filterTouchesWhenObscured:
3413 if (a.getBoolean(attr, false)) {
3414 viewFlagValues |= FILTER_TOUCHES_WHEN_OBSCURED;
3415 viewFlagMasks |= FILTER_TOUCHES_WHEN_OBSCURED;
3416 }
3417 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003418 case R.styleable.View_nextFocusLeft:
3419 mNextFocusLeftId = a.getResourceId(attr, View.NO_ID);
3420 break;
3421 case R.styleable.View_nextFocusRight:
3422 mNextFocusRightId = a.getResourceId(attr, View.NO_ID);
3423 break;
3424 case R.styleable.View_nextFocusUp:
3425 mNextFocusUpId = a.getResourceId(attr, View.NO_ID);
3426 break;
3427 case R.styleable.View_nextFocusDown:
3428 mNextFocusDownId = a.getResourceId(attr, View.NO_ID);
3429 break;
Jeff Brown4e6319b2010-12-13 10:36:51 -08003430 case R.styleable.View_nextFocusForward:
3431 mNextFocusForwardId = a.getResourceId(attr, View.NO_ID);
3432 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003433 case R.styleable.View_minWidth:
3434 mMinWidth = a.getDimensionPixelSize(attr, 0);
3435 break;
3436 case R.styleable.View_minHeight:
3437 mMinHeight = a.getDimensionPixelSize(attr, 0);
3438 break;
Romain Guy9a817362009-05-01 10:57:14 -07003439 case R.styleable.View_onClick:
Romain Guy870e09f2009-07-06 16:35:25 -07003440 if (context.isRestricted()) {
Joe Malin32736f02011-01-19 16:14:20 -08003441 throw new IllegalStateException("The android:onClick attribute cannot "
Romain Guy870e09f2009-07-06 16:35:25 -07003442 + "be used within a restricted context");
3443 }
3444
Romain Guy9a817362009-05-01 10:57:14 -07003445 final String handlerName = a.getString(attr);
3446 if (handlerName != null) {
3447 setOnClickListener(new OnClickListener() {
3448 private Method mHandler;
3449
3450 public void onClick(View v) {
3451 if (mHandler == null) {
3452 try {
3453 mHandler = getContext().getClass().getMethod(handlerName,
3454 View.class);
3455 } catch (NoSuchMethodException e) {
Joe Onorato42e14d72010-03-11 14:51:17 -08003456 int id = getId();
3457 String idText = id == NO_ID ? "" : " with id '"
3458 + getContext().getResources().getResourceEntryName(
3459 id) + "'";
Romain Guy9a817362009-05-01 10:57:14 -07003460 throw new IllegalStateException("Could not find a method " +
Joe Onorato42e14d72010-03-11 14:51:17 -08003461 handlerName + "(View) in the activity "
3462 + getContext().getClass() + " for onClick handler"
3463 + " on view " + View.this.getClass() + idText, e);
Romain Guy9a817362009-05-01 10:57:14 -07003464 }
3465 }
3466
3467 try {
3468 mHandler.invoke(getContext(), View.this);
3469 } catch (IllegalAccessException e) {
3470 throw new IllegalStateException("Could not execute non "
3471 + "public method of the activity", e);
3472 } catch (InvocationTargetException e) {
3473 throw new IllegalStateException("Could not execute "
3474 + "method of the activity", e);
3475 }
3476 }
3477 });
3478 }
3479 break;
Adam Powell637d3372010-08-25 14:37:03 -07003480 case R.styleable.View_overScrollMode:
3481 overScrollMode = a.getInt(attr, OVER_SCROLL_IF_CONTENT_SCROLLS);
3482 break;
Adam Powell20232d02010-12-08 21:08:53 -08003483 case R.styleable.View_verticalScrollbarPosition:
3484 mVerticalScrollbarPosition = a.getInt(attr, SCROLLBAR_POSITION_DEFAULT);
3485 break;
Romain Guy171c5922011-01-06 10:04:23 -08003486 case R.styleable.View_layerType:
3487 setLayerType(a.getInt(attr, LAYER_TYPE_NONE), null);
3488 break;
Fabrice Di Meglio22268862011-06-27 18:13:18 -07003489 case R.styleable.View_textDirection:
Fabrice Di Megliob934db72012-03-20 14:33:01 -07003490 // Clear any text direction flag already set
3491 mPrivateFlags2 &= ~TEXT_DIRECTION_MASK;
3492 // Set the text direction flags depending on the value of the attribute
3493 final int textDirection = a.getInt(attr, -1);
3494 if (textDirection != -1) {
3495 mPrivateFlags2 |= TEXT_DIRECTION_FLAGS[textDirection];
3496 }
Fabrice Di Meglio22268862011-06-27 18:13:18 -07003497 break;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07003498 case R.styleable.View_textAlignment:
3499 // Clear any text alignment flag already set
3500 mPrivateFlags2 &= ~TEXT_ALIGNMENT_MASK;
3501 // Set the text alignment flag depending on the value of the attribute
3502 final int textAlignment = a.getInt(attr, TEXT_ALIGNMENT_DEFAULT);
3503 mPrivateFlags2 |= TEXT_ALIGNMENT_FLAGS[textAlignment];
3504 break;
Svetoslav Ganov42138042012-03-20 11:51:39 -07003505 case R.styleable.View_importantForAccessibility:
3506 setImportantForAccessibility(a.getInt(attr,
3507 IMPORTANT_FOR_ACCESSIBILITY_DEFAULT));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003508 }
3509 }
3510
Dianne Hackbornab0f4852011-09-12 16:59:06 -07003511 a.recycle();
3512
Adam Powell637d3372010-08-25 14:37:03 -07003513 setOverScrollMode(overScrollMode);
3514
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003515 if (background != null) {
Philip Milne6c8ea062012-04-03 17:38:43 -07003516 setBackground(background);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003517 }
3518
Fabrice Di Megliof9e36502011-06-21 18:41:48 -07003519 // Cache user padding as we cannot fully resolve padding here (we dont have yet the resolved
3520 // layout direction). Those cached values will be used later during padding resolution.
3521 mUserPaddingStart = startPadding;
3522 mUserPaddingEnd = endPadding;
3523
Fabrice Di Meglio509708d2012-03-06 15:41:11 -08003524 updateUserPaddingRelative();
3525
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003526 if (padding >= 0) {
3527 leftPadding = padding;
3528 topPadding = padding;
3529 rightPadding = padding;
3530 bottomPadding = padding;
3531 }
3532
3533 // If the user specified the padding (either with android:padding or
3534 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise
3535 // use the default padding or the padding from the background drawable
3536 // (stored at this point in mPadding*)
3537 setPadding(leftPadding >= 0 ? leftPadding : mPaddingLeft,
3538 topPadding >= 0 ? topPadding : mPaddingTop,
3539 rightPadding >= 0 ? rightPadding : mPaddingRight,
3540 bottomPadding >= 0 ? bottomPadding : mPaddingBottom);
3541
3542 if (viewFlagMasks != 0) {
3543 setFlags(viewFlagValues, viewFlagMasks);
3544 }
3545
3546 // Needs to be called after mViewFlags is set
3547 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
3548 recomputePadding();
3549 }
3550
3551 if (x != 0 || y != 0) {
3552 scrollTo(x, y);
3553 }
3554
Chet Haase73066682010-11-29 15:55:32 -08003555 if (transformSet) {
3556 setTranslationX(tx);
3557 setTranslationY(ty);
3558 setRotation(rotation);
3559 setRotationX(rotationX);
3560 setRotationY(rotationY);
3561 setScaleX(sx);
3562 setScaleY(sy);
3563 }
3564
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003565 if (!setScrollContainer && (viewFlagValues&SCROLLBARS_VERTICAL) != 0) {
3566 setScrollContainer(true);
3567 }
Romain Guy8f1344f52009-05-15 16:03:59 -07003568
3569 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003570 }
3571
Fabrice Di Meglio509708d2012-03-06 15:41:11 -08003572 private void updateUserPaddingRelative() {
3573 mUserPaddingRelative = (mUserPaddingStart >= 0 || mUserPaddingEnd >= 0);
3574 }
3575
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003576 /**
3577 * Non-public constructor for use in testing
3578 */
3579 View() {
Dianne Hackbornab0f4852011-09-12 16:59:06 -07003580 mResources = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003581 }
3582
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003583 /**
3584 * <p>
3585 * Initializes the fading edges from a given set of styled attributes. This
3586 * method should be called by subclasses that need fading edges and when an
3587 * instance of these subclasses is created programmatically rather than
3588 * being inflated from XML. This method is automatically called when the XML
3589 * is inflated.
3590 * </p>
3591 *
3592 * @param a the styled attributes set to initialize the fading edges from
3593 */
3594 protected void initializeFadingEdge(TypedArray a) {
3595 initScrollCache();
3596
3597 mScrollCache.fadingEdgeLength = a.getDimensionPixelSize(
3598 R.styleable.View_fadingEdgeLength,
3599 ViewConfiguration.get(mContext).getScaledFadingEdgeLength());
3600 }
3601
3602 /**
3603 * Returns the size of the vertical faded edges used to indicate that more
3604 * content in this view is visible.
3605 *
3606 * @return The size in pixels of the vertical faded edge or 0 if vertical
3607 * faded edges are not enabled for this view.
3608 * @attr ref android.R.styleable#View_fadingEdgeLength
3609 */
3610 public int getVerticalFadingEdgeLength() {
3611 if (isVerticalFadingEdgeEnabled()) {
3612 ScrollabilityCache cache = mScrollCache;
3613 if (cache != null) {
3614 return cache.fadingEdgeLength;
3615 }
3616 }
3617 return 0;
3618 }
3619
3620 /**
3621 * Set the size of the faded edge used to indicate that more content in this
3622 * view is available. Will not change whether the fading edge is enabled; use
Romain Guy5c22a8c2011-05-13 11:48:45 -07003623 * {@link #setVerticalFadingEdgeEnabled(boolean)} or
3624 * {@link #setHorizontalFadingEdgeEnabled(boolean)} to enable the fading edge
3625 * for the vertical or horizontal fading edges.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003626 *
3627 * @param length The size in pixels of the faded edge used to indicate that more
3628 * content in this view is visible.
3629 */
3630 public void setFadingEdgeLength(int length) {
3631 initScrollCache();
3632 mScrollCache.fadingEdgeLength = length;
3633 }
3634
3635 /**
3636 * Returns the size of the horizontal faded edges used to indicate that more
3637 * content in this view is visible.
3638 *
3639 * @return The size in pixels of the horizontal faded edge or 0 if horizontal
3640 * faded edges are not enabled for this view.
3641 * @attr ref android.R.styleable#View_fadingEdgeLength
3642 */
3643 public int getHorizontalFadingEdgeLength() {
3644 if (isHorizontalFadingEdgeEnabled()) {
3645 ScrollabilityCache cache = mScrollCache;
3646 if (cache != null) {
3647 return cache.fadingEdgeLength;
3648 }
3649 }
3650 return 0;
3651 }
3652
3653 /**
3654 * Returns the width of the vertical scrollbar.
3655 *
3656 * @return The width in pixels of the vertical scrollbar or 0 if there
3657 * is no vertical scrollbar.
3658 */
3659 public int getVerticalScrollbarWidth() {
3660 ScrollabilityCache cache = mScrollCache;
3661 if (cache != null) {
3662 ScrollBarDrawable scrollBar = cache.scrollBar;
3663 if (scrollBar != null) {
3664 int size = scrollBar.getSize(true);
3665 if (size <= 0) {
3666 size = cache.scrollBarSize;
3667 }
3668 return size;
3669 }
3670 return 0;
3671 }
3672 return 0;
3673 }
3674
3675 /**
3676 * Returns the height of the horizontal scrollbar.
3677 *
3678 * @return The height in pixels of the horizontal scrollbar or 0 if
3679 * there is no horizontal scrollbar.
3680 */
3681 protected int getHorizontalScrollbarHeight() {
3682 ScrollabilityCache cache = mScrollCache;
3683 if (cache != null) {
3684 ScrollBarDrawable scrollBar = cache.scrollBar;
3685 if (scrollBar != null) {
3686 int size = scrollBar.getSize(false);
3687 if (size <= 0) {
3688 size = cache.scrollBarSize;
3689 }
3690 return size;
3691 }
3692 return 0;
3693 }
3694 return 0;
3695 }
3696
3697 /**
3698 * <p>
3699 * Initializes the scrollbars from a given set of styled attributes. This
3700 * method should be called by subclasses that need scrollbars and when an
3701 * instance of these subclasses is created programmatically rather than
3702 * being inflated from XML. This method is automatically called when the XML
3703 * is inflated.
3704 * </p>
3705 *
3706 * @param a the styled attributes set to initialize the scrollbars from
3707 */
3708 protected void initializeScrollbars(TypedArray a) {
3709 initScrollCache();
3710
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003711 final ScrollabilityCache scrollabilityCache = mScrollCache;
Joe Malin32736f02011-01-19 16:14:20 -08003712
Mike Cleronf116bf82009-09-27 19:14:12 -07003713 if (scrollabilityCache.scrollBar == null) {
3714 scrollabilityCache.scrollBar = new ScrollBarDrawable();
3715 }
Joe Malin32736f02011-01-19 16:14:20 -08003716
Romain Guy8bda2482010-03-02 11:42:11 -08003717 final boolean fadeScrollbars = a.getBoolean(R.styleable.View_fadeScrollbars, true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003718
Mike Cleronf116bf82009-09-27 19:14:12 -07003719 if (!fadeScrollbars) {
3720 scrollabilityCache.state = ScrollabilityCache.ON;
3721 }
3722 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Joe Malin32736f02011-01-19 16:14:20 -08003723
3724
Mike Cleronf116bf82009-09-27 19:14:12 -07003725 scrollabilityCache.scrollBarFadeDuration = a.getInt(
3726 R.styleable.View_scrollbarFadeDuration, ViewConfiguration
3727 .getScrollBarFadeDuration());
3728 scrollabilityCache.scrollBarDefaultDelayBeforeFade = a.getInt(
3729 R.styleable.View_scrollbarDefaultDelayBeforeFade,
3730 ViewConfiguration.getScrollDefaultDelay());
3731
Joe Malin32736f02011-01-19 16:14:20 -08003732
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003733 scrollabilityCache.scrollBarSize = a.getDimensionPixelSize(
3734 com.android.internal.R.styleable.View_scrollbarSize,
3735 ViewConfiguration.get(mContext).getScaledScrollBarSize());
3736
3737 Drawable track = a.getDrawable(R.styleable.View_scrollbarTrackHorizontal);
3738 scrollabilityCache.scrollBar.setHorizontalTrackDrawable(track);
3739
3740 Drawable thumb = a.getDrawable(R.styleable.View_scrollbarThumbHorizontal);
3741 if (thumb != null) {
3742 scrollabilityCache.scrollBar.setHorizontalThumbDrawable(thumb);
3743 }
3744
3745 boolean alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawHorizontalTrack,
3746 false);
3747 if (alwaysDraw) {
3748 scrollabilityCache.scrollBar.setAlwaysDrawHorizontalTrack(true);
3749 }
3750
3751 track = a.getDrawable(R.styleable.View_scrollbarTrackVertical);
3752 scrollabilityCache.scrollBar.setVerticalTrackDrawable(track);
3753
3754 thumb = a.getDrawable(R.styleable.View_scrollbarThumbVertical);
3755 if (thumb != null) {
3756 scrollabilityCache.scrollBar.setVerticalThumbDrawable(thumb);
3757 }
3758
3759 alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawVerticalTrack,
3760 false);
3761 if (alwaysDraw) {
3762 scrollabilityCache.scrollBar.setAlwaysDrawVerticalTrack(true);
3763 }
3764
3765 // Re-apply user/background padding so that scrollbar(s) get added
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003766 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003767 }
3768
3769 /**
3770 * <p>
3771 * Initalizes the scrollability cache if necessary.
3772 * </p>
3773 */
3774 private void initScrollCache() {
3775 if (mScrollCache == null) {
Mike Cleronf116bf82009-09-27 19:14:12 -07003776 mScrollCache = new ScrollabilityCache(ViewConfiguration.get(mContext), this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003777 }
3778 }
3779
Philip Milne6c8ea062012-04-03 17:38:43 -07003780 private ScrollabilityCache getScrollCache() {
3781 initScrollCache();
3782 return mScrollCache;
3783 }
3784
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003785 /**
Adam Powell20232d02010-12-08 21:08:53 -08003786 * Set the position of the vertical scroll bar. Should be one of
3787 * {@link #SCROLLBAR_POSITION_DEFAULT}, {@link #SCROLLBAR_POSITION_LEFT} or
3788 * {@link #SCROLLBAR_POSITION_RIGHT}.
3789 *
3790 * @param position Where the vertical scroll bar should be positioned.
3791 */
3792 public void setVerticalScrollbarPosition(int position) {
3793 if (mVerticalScrollbarPosition != position) {
3794 mVerticalScrollbarPosition = position;
3795 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003796 resolvePadding();
Adam Powell20232d02010-12-08 21:08:53 -08003797 }
3798 }
3799
3800 /**
3801 * @return The position where the vertical scroll bar will show, if applicable.
3802 * @see #setVerticalScrollbarPosition(int)
3803 */
3804 public int getVerticalScrollbarPosition() {
3805 return mVerticalScrollbarPosition;
3806 }
3807
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003808 ListenerInfo getListenerInfo() {
3809 if (mListenerInfo != null) {
3810 return mListenerInfo;
3811 }
3812 mListenerInfo = new ListenerInfo();
3813 return mListenerInfo;
3814 }
3815
Adam Powell20232d02010-12-08 21:08:53 -08003816 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003817 * Register a callback to be invoked when focus of this view changed.
3818 *
3819 * @param l The callback that will run.
3820 */
3821 public void setOnFocusChangeListener(OnFocusChangeListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003822 getListenerInfo().mOnFocusChangeListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003823 }
3824
3825 /**
Chet Haase21cd1382010-09-01 17:42:29 -07003826 * Add a listener that will be called when the bounds of the view change due to
3827 * layout processing.
3828 *
3829 * @param listener The listener that will be called when layout bounds change.
3830 */
3831 public void addOnLayoutChangeListener(OnLayoutChangeListener listener) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003832 ListenerInfo li = getListenerInfo();
3833 if (li.mOnLayoutChangeListeners == null) {
3834 li.mOnLayoutChangeListeners = new ArrayList<OnLayoutChangeListener>();
Chet Haase21cd1382010-09-01 17:42:29 -07003835 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003836 if (!li.mOnLayoutChangeListeners.contains(listener)) {
3837 li.mOnLayoutChangeListeners.add(listener);
Chet Haase1a76dcd2011-10-06 11:16:40 -07003838 }
Chet Haase21cd1382010-09-01 17:42:29 -07003839 }
3840
3841 /**
3842 * Remove a listener for layout changes.
3843 *
3844 * @param listener The listener for layout bounds change.
3845 */
3846 public void removeOnLayoutChangeListener(OnLayoutChangeListener listener) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003847 ListenerInfo li = mListenerInfo;
3848 if (li == null || li.mOnLayoutChangeListeners == null) {
Chet Haase21cd1382010-09-01 17:42:29 -07003849 return;
3850 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003851 li.mOnLayoutChangeListeners.remove(listener);
Chet Haase21cd1382010-09-01 17:42:29 -07003852 }
3853
3854 /**
Adam Powell4afd62b2011-02-18 15:02:18 -08003855 * Add a listener for attach state changes.
3856 *
3857 * This listener will be called whenever this view is attached or detached
3858 * from a window. Remove the listener using
3859 * {@link #removeOnAttachStateChangeListener(OnAttachStateChangeListener)}.
3860 *
3861 * @param listener Listener to attach
3862 * @see #removeOnAttachStateChangeListener(OnAttachStateChangeListener)
3863 */
3864 public void addOnAttachStateChangeListener(OnAttachStateChangeListener listener) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003865 ListenerInfo li = getListenerInfo();
3866 if (li.mOnAttachStateChangeListeners == null) {
3867 li.mOnAttachStateChangeListeners
3868 = new CopyOnWriteArrayList<OnAttachStateChangeListener>();
Adam Powell4afd62b2011-02-18 15:02:18 -08003869 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003870 li.mOnAttachStateChangeListeners.add(listener);
Adam Powell4afd62b2011-02-18 15:02:18 -08003871 }
3872
3873 /**
3874 * Remove a listener for attach state changes. The listener will receive no further
3875 * notification of window attach/detach events.
3876 *
3877 * @param listener Listener to remove
3878 * @see #addOnAttachStateChangeListener(OnAttachStateChangeListener)
3879 */
3880 public void removeOnAttachStateChangeListener(OnAttachStateChangeListener listener) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003881 ListenerInfo li = mListenerInfo;
3882 if (li == null || li.mOnAttachStateChangeListeners == null) {
Adam Powell4afd62b2011-02-18 15:02:18 -08003883 return;
3884 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003885 li.mOnAttachStateChangeListeners.remove(listener);
Adam Powell4afd62b2011-02-18 15:02:18 -08003886 }
3887
3888 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003889 * Returns the focus-change callback registered for this view.
3890 *
3891 * @return The callback, or null if one is not registered.
3892 */
3893 public OnFocusChangeListener getOnFocusChangeListener() {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003894 ListenerInfo li = mListenerInfo;
3895 return li != null ? li.mOnFocusChangeListener : null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003896 }
3897
3898 /**
3899 * Register a callback to be invoked when this view is clicked. If this view is not
3900 * clickable, it becomes clickable.
3901 *
3902 * @param l The callback that will run
3903 *
3904 * @see #setClickable(boolean)
3905 */
3906 public void setOnClickListener(OnClickListener l) {
3907 if (!isClickable()) {
3908 setClickable(true);
3909 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003910 getListenerInfo().mOnClickListener = l;
3911 }
3912
3913 /**
3914 * Return whether this view has an attached OnClickListener. Returns
3915 * true if there is a listener, false if there is none.
3916 */
3917 public boolean hasOnClickListeners() {
3918 ListenerInfo li = mListenerInfo;
3919 return (li != null && li.mOnClickListener != null);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003920 }
3921
3922 /**
3923 * Register a callback to be invoked when this view is clicked and held. If this view is not
3924 * long clickable, it becomes long clickable.
3925 *
3926 * @param l The callback that will run
3927 *
3928 * @see #setLongClickable(boolean)
3929 */
3930 public void setOnLongClickListener(OnLongClickListener l) {
3931 if (!isLongClickable()) {
3932 setLongClickable(true);
3933 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003934 getListenerInfo().mOnLongClickListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003935 }
3936
3937 /**
3938 * Register a callback to be invoked when the context menu for this view is
3939 * being built. If this view is not long clickable, it becomes long clickable.
3940 *
3941 * @param l The callback that will run
3942 *
3943 */
3944 public void setOnCreateContextMenuListener(OnCreateContextMenuListener l) {
3945 if (!isLongClickable()) {
3946 setLongClickable(true);
3947 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003948 getListenerInfo().mOnCreateContextMenuListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003949 }
3950
3951 /**
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003952 * Call this view's OnClickListener, if it is defined. Performs all normal
3953 * actions associated with clicking: reporting accessibility event, playing
3954 * a sound, etc.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003955 *
3956 * @return True there was an assigned OnClickListener that was called, false
3957 * otherwise is returned.
3958 */
3959 public boolean performClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07003960 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED);
3961
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003962 ListenerInfo li = mListenerInfo;
3963 if (li != null && li.mOnClickListener != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003964 playSoundEffect(SoundEffectConstants.CLICK);
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003965 li.mOnClickListener.onClick(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003966 return true;
3967 }
3968
3969 return false;
3970 }
3971
3972 /**
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003973 * Directly call any attached OnClickListener. Unlike {@link #performClick()},
3974 * this only calls the listener, and does not do any associated clicking
3975 * actions like reporting an accessibility event.
3976 *
3977 * @return True there was an assigned OnClickListener that was called, false
3978 * otherwise is returned.
3979 */
3980 public boolean callOnClick() {
3981 ListenerInfo li = mListenerInfo;
3982 if (li != null && li.mOnClickListener != null) {
3983 li.mOnClickListener.onClick(this);
3984 return true;
3985 }
3986 return false;
3987 }
3988
3989 /**
Gilles Debunnef788a9f2010-07-22 10:17:23 -07003990 * Call this view's OnLongClickListener, if it is defined. Invokes the context menu if the
3991 * OnLongClickListener did not consume the event.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003992 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07003993 * @return True if one of the above receivers consumed the event, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003994 */
3995 public boolean performLongClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07003996 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED);
3997
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003998 boolean handled = false;
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003999 ListenerInfo li = mListenerInfo;
4000 if (li != null && li.mOnLongClickListener != null) {
4001 handled = li.mOnLongClickListener.onLongClick(View.this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004002 }
4003 if (!handled) {
4004 handled = showContextMenu();
4005 }
4006 if (handled) {
4007 performHapticFeedback(HapticFeedbackConstants.LONG_PRESS);
4008 }
4009 return handled;
4010 }
4011
4012 /**
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07004013 * Performs button-related actions during a touch down event.
4014 *
4015 * @param event The event.
4016 * @return True if the down was consumed.
4017 *
4018 * @hide
4019 */
4020 protected boolean performButtonActionOnTouchDown(MotionEvent event) {
4021 if ((event.getButtonState() & MotionEvent.BUTTON_SECONDARY) != 0) {
4022 if (showContextMenu(event.getX(), event.getY(), event.getMetaState())) {
4023 return true;
4024 }
4025 }
4026 return false;
4027 }
4028
4029 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004030 * Bring up the context menu for this view.
4031 *
4032 * @return Whether a context menu was displayed.
4033 */
4034 public boolean showContextMenu() {
4035 return getParent().showContextMenuForChild(this);
4036 }
4037
4038 /**
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07004039 * Bring up the context menu for this view, referring to the item under the specified point.
4040 *
4041 * @param x The referenced x coordinate.
4042 * @param y The referenced y coordinate.
4043 * @param metaState The keyboard modifiers that were pressed.
4044 * @return Whether a context menu was displayed.
4045 *
4046 * @hide
4047 */
4048 public boolean showContextMenu(float x, float y, int metaState) {
4049 return showContextMenu();
4050 }
4051
4052 /**
Adam Powell6e346362010-07-23 10:18:23 -07004053 * Start an action mode.
4054 *
4055 * @param callback Callback that will control the lifecycle of the action mode
4056 * @return The new action mode if it is started, null otherwise
4057 *
4058 * @see ActionMode
4059 */
4060 public ActionMode startActionMode(ActionMode.Callback callback) {
John Reck5160e2a2012-02-22 09:35:12 -08004061 ViewParent parent = getParent();
4062 if (parent == null) return null;
4063 return parent.startActionModeForChild(this, callback);
Adam Powell6e346362010-07-23 10:18:23 -07004064 }
4065
4066 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004067 * Register a callback to be invoked when a key is pressed in this view.
4068 * @param l the key listener to attach to this view
4069 */
4070 public void setOnKeyListener(OnKeyListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004071 getListenerInfo().mOnKeyListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004072 }
4073
4074 /**
4075 * Register a callback to be invoked when a touch event is sent to this view.
4076 * @param l the touch listener to attach to this view
4077 */
4078 public void setOnTouchListener(OnTouchListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004079 getListenerInfo().mOnTouchListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004080 }
4081
4082 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08004083 * Register a callback to be invoked when a generic motion event is sent to this view.
4084 * @param l the generic motion listener to attach to this view
4085 */
4086 public void setOnGenericMotionListener(OnGenericMotionListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004087 getListenerInfo().mOnGenericMotionListener = l;
Jeff Brown33bbfd22011-02-24 20:55:35 -08004088 }
4089
4090 /**
Jeff Brown53ca3f12011-06-27 18:36:00 -07004091 * Register a callback to be invoked when a hover event is sent to this view.
4092 * @param l the hover listener to attach to this view
4093 */
4094 public void setOnHoverListener(OnHoverListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004095 getListenerInfo().mOnHoverListener = l;
Jeff Brown53ca3f12011-06-27 18:36:00 -07004096 }
4097
4098 /**
Joe Malin32736f02011-01-19 16:14:20 -08004099 * Register a drag event listener callback object for this View. The parameter is
4100 * an implementation of {@link android.view.View.OnDragListener}. To send a drag event to a
4101 * View, the system calls the
4102 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent)} method.
4103 * @param l An implementation of {@link android.view.View.OnDragListener}.
Chris Tate32affef2010-10-18 15:29:21 -07004104 */
4105 public void setOnDragListener(OnDragListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004106 getListenerInfo().mOnDragListener = l;
Chris Tate32affef2010-10-18 15:29:21 -07004107 }
4108
4109 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07004110 * Give this view focus. This will cause
4111 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} to be called.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004112 *
4113 * Note: this does not check whether this {@link View} should get focus, it just
4114 * gives it focus no matter what. It should only be called internally by framework
4115 * code that knows what it is doing, namely {@link #requestFocus(int, Rect)}.
4116 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08004117 * @param direction values are {@link View#FOCUS_UP}, {@link View#FOCUS_DOWN},
4118 * {@link View#FOCUS_LEFT} or {@link View#FOCUS_RIGHT}. This is the direction which
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004119 * focus moved when requestFocus() is called. It may not always
4120 * apply, in which case use the default View.FOCUS_DOWN.
4121 * @param previouslyFocusedRect The rectangle of the view that had focus
4122 * prior in this View's coordinate system.
4123 */
4124 void handleFocusGainInternal(int direction, Rect previouslyFocusedRect) {
4125 if (DBG) {
4126 System.out.println(this + " requestFocus()");
4127 }
4128
4129 if ((mPrivateFlags & FOCUSED) == 0) {
4130 mPrivateFlags |= FOCUSED;
4131
4132 if (mParent != null) {
4133 mParent.requestChildFocus(this, this);
4134 }
4135
4136 onFocusChanged(true, direction, previouslyFocusedRect);
4137 refreshDrawableState();
Svetoslav Ganov42138042012-03-20 11:51:39 -07004138
4139 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4140 notifyAccessibilityStateChanged();
4141 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004142 }
4143 }
4144
4145 /**
4146 * Request that a rectangle of this view be visible on the screen,
4147 * scrolling if necessary just enough.
4148 *
4149 * <p>A View should call this if it maintains some notion of which part
4150 * of its content is interesting. For example, a text editing view
4151 * should call this when its cursor moves.
4152 *
4153 * @param rectangle The rectangle.
4154 * @return Whether any parent scrolled.
4155 */
4156 public boolean requestRectangleOnScreen(Rect rectangle) {
4157 return requestRectangleOnScreen(rectangle, false);
4158 }
4159
4160 /**
4161 * Request that a rectangle of this view be visible on the screen,
4162 * scrolling if necessary just enough.
4163 *
4164 * <p>A View should call this if it maintains some notion of which part
4165 * of its content is interesting. For example, a text editing view
4166 * should call this when its cursor moves.
4167 *
4168 * <p>When <code>immediate</code> is set to true, scrolling will not be
4169 * animated.
4170 *
4171 * @param rectangle The rectangle.
4172 * @param immediate True to forbid animated scrolling, false otherwise
4173 * @return Whether any parent scrolled.
4174 */
4175 public boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) {
4176 View child = this;
4177 ViewParent parent = mParent;
4178 boolean scrolled = false;
4179 while (parent != null) {
4180 scrolled |= parent.requestChildRectangleOnScreen(child,
4181 rectangle, immediate);
4182
4183 // offset rect so next call has the rectangle in the
4184 // coordinate system of its direct child.
4185 rectangle.offset(child.getLeft(), child.getTop());
4186 rectangle.offset(-child.getScrollX(), -child.getScrollY());
4187
4188 if (!(parent instanceof View)) {
4189 break;
4190 }
Romain Guy8506ab42009-06-11 17:35:47 -07004191
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004192 child = (View) parent;
4193 parent = child.getParent();
4194 }
4195 return scrolled;
4196 }
4197
4198 /**
Svetoslav Ganov13fd5612012-02-01 17:01:12 -08004199 * Called when this view wants to give up focus. If focus is cleared
4200 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} is called.
4201 * <p>
4202 * <strong>Note:</strong> When a View clears focus the framework is trying
4203 * to give focus to the first focusable View from the top. Hence, if this
Svetoslav Ganov57cadf22012-04-04 16:44:39 -07004204 * View is the first from the top that can take focus, then all callbacks
4205 * related to clearing focus will be invoked after wich the framework will
4206 * give focus to this view.
Svetoslav Ganov13fd5612012-02-01 17:01:12 -08004207 * </p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004208 */
4209 public void clearFocus() {
4210 if (DBG) {
4211 System.out.println(this + " clearFocus()");
4212 }
4213
4214 if ((mPrivateFlags & FOCUSED) != 0) {
4215 mPrivateFlags &= ~FOCUSED;
4216
4217 if (mParent != null) {
4218 mParent.clearChildFocus(this);
4219 }
4220
4221 onFocusChanged(false, 0, null);
Svetoslav Ganov42138042012-03-20 11:51:39 -07004222
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004223 refreshDrawableState();
Svetoslav Ganov57cadf22012-04-04 16:44:39 -07004224
4225 ensureInputFocusOnFirstFocusable();
Svetoslav Ganov42138042012-03-20 11:51:39 -07004226
4227 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4228 notifyAccessibilityStateChanged();
4229 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004230 }
4231 }
4232
Svetoslav Ganov57cadf22012-04-04 16:44:39 -07004233 void ensureInputFocusOnFirstFocusable() {
4234 View root = getRootView();
4235 if (root != null) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004236 root.requestFocus();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004237 }
4238 }
4239
4240 /**
4241 * Called internally by the view system when a new view is getting focus.
4242 * This is what clears the old focus.
4243 */
4244 void unFocus() {
4245 if (DBG) {
4246 System.out.println(this + " unFocus()");
4247 }
4248
4249 if ((mPrivateFlags & FOCUSED) != 0) {
4250 mPrivateFlags &= ~FOCUSED;
4251
4252 onFocusChanged(false, 0, null);
4253 refreshDrawableState();
Svetoslav Ganov42138042012-03-20 11:51:39 -07004254
4255 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4256 notifyAccessibilityStateChanged();
4257 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004258 }
4259 }
4260
4261 /**
4262 * Returns true if this view has focus iteself, or is the ancestor of the
4263 * view that has focus.
4264 *
4265 * @return True if this view has or contains focus, false otherwise.
4266 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004267 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004268 public boolean hasFocus() {
4269 return (mPrivateFlags & FOCUSED) != 0;
4270 }
4271
4272 /**
4273 * Returns true if this view is focusable or if it contains a reachable View
4274 * for which {@link #hasFocusable()} returns true. A "reachable hasFocusable()"
4275 * is a View whose parents do not block descendants focus.
4276 *
4277 * Only {@link #VISIBLE} views are considered focusable.
4278 *
4279 * @return True if the view is focusable or if the view contains a focusable
4280 * View, false otherwise.
4281 *
4282 * @see ViewGroup#FOCUS_BLOCK_DESCENDANTS
4283 */
4284 public boolean hasFocusable() {
4285 return (mViewFlags & VISIBILITY_MASK) == VISIBLE && isFocusable();
4286 }
4287
4288 /**
4289 * Called by the view system when the focus state of this view changes.
4290 * When the focus change event is caused by directional navigation, direction
4291 * and previouslyFocusedRect provide insight into where the focus is coming from.
4292 * When overriding, be sure to call up through to the super class so that
4293 * the standard focus handling will occur.
Romain Guy8506ab42009-06-11 17:35:47 -07004294 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004295 * @param gainFocus True if the View has focus; false otherwise.
4296 * @param direction The direction focus has moved when requestFocus()
4297 * is called to give this view focus. Values are
Jeff Brown4e6319b2010-12-13 10:36:51 -08004298 * {@link #FOCUS_UP}, {@link #FOCUS_DOWN}, {@link #FOCUS_LEFT},
4299 * {@link #FOCUS_RIGHT}, {@link #FOCUS_FORWARD}, or {@link #FOCUS_BACKWARD}.
4300 * It may not always apply, in which case use the default.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004301 * @param previouslyFocusedRect The rectangle, in this view's coordinate
4302 * system, of the previously focused view. If applicable, this will be
4303 * passed in as finer grained information about where the focus is coming
4304 * from (in addition to direction). Will be <code>null</code> otherwise.
4305 */
4306 protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) {
svetoslavganov75986cf2009-05-14 22:28:01 -07004307 if (gainFocus) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004308 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4309 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED);
4310 requestAccessibilityFocus();
4311 }
svetoslavganov75986cf2009-05-14 22:28:01 -07004312 }
4313
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004314 InputMethodManager imm = InputMethodManager.peekInstance();
4315 if (!gainFocus) {
4316 if (isPressed()) {
4317 setPressed(false);
4318 }
4319 if (imm != null && mAttachInfo != null
4320 && mAttachInfo.mHasWindowFocus) {
4321 imm.focusOut(this);
4322 }
Romain Guya2431d02009-04-30 16:30:00 -07004323 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004324 } else if (imm != null && mAttachInfo != null
4325 && mAttachInfo.mHasWindowFocus) {
4326 imm.focusIn(this);
4327 }
Romain Guy8506ab42009-06-11 17:35:47 -07004328
Romain Guy0fd89bf2011-01-26 15:41:30 -08004329 invalidate(true);
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004330 ListenerInfo li = mListenerInfo;
4331 if (li != null && li.mOnFocusChangeListener != null) {
4332 li.mOnFocusChangeListener.onFocusChange(this, gainFocus);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004333 }
Joe Malin32736f02011-01-19 16:14:20 -08004334
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004335 if (mAttachInfo != null) {
4336 mAttachInfo.mKeyDispatchState.reset(this);
4337 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004338 }
4339
4340 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07004341 * Sends an accessibility event of the given type. If accessiiblity is
4342 * not enabled this method has no effect. The default implementation calls
4343 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)} first
4344 * to populate information about the event source (this View), then calls
4345 * {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)} to
4346 * populate the text content of the event source including its descendants,
4347 * and last calls
4348 * {@link ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent)}
4349 * on its parent to resuest sending of the event to interested parties.
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004350 * <p>
4351 * If an {@link AccessibilityDelegate} has been specified via calling
4352 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4353 * {@link AccessibilityDelegate#sendAccessibilityEvent(View, int)} is
4354 * responsible for handling this call.
4355 * </p>
Svetoslav Ganov30401322011-05-12 18:53:45 -07004356 *
Scott Mainb303d832011-10-12 16:45:18 -07004357 * @param eventType The type of the event to send, as defined by several types from
4358 * {@link android.view.accessibility.AccessibilityEvent}, such as
4359 * {@link android.view.accessibility.AccessibilityEvent#TYPE_VIEW_CLICKED} or
4360 * {@link android.view.accessibility.AccessibilityEvent#TYPE_VIEW_HOVER_ENTER}.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004361 *
4362 * @see #onInitializeAccessibilityEvent(AccessibilityEvent)
4363 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
4364 * @see ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent)
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004365 * @see AccessibilityDelegate
svetoslavganov75986cf2009-05-14 22:28:01 -07004366 */
4367 public void sendAccessibilityEvent(int eventType) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004368 if (mAccessibilityDelegate != null) {
4369 mAccessibilityDelegate.sendAccessibilityEvent(this, eventType);
4370 } else {
4371 sendAccessibilityEventInternal(eventType);
4372 }
4373 }
4374
4375 /**
Svetoslav Ganov51ab90c2012-03-09 10:54:49 -08004376 * Convenience method for sending a {@link AccessibilityEvent#TYPE_ANNOUNCEMENT}
4377 * {@link AccessibilityEvent} to make an announcement which is related to some
4378 * sort of a context change for which none of the events representing UI transitions
4379 * is a good fit. For example, announcing a new page in a book. If accessibility
4380 * is not enabled this method does nothing.
4381 *
4382 * @param text The announcement text.
4383 */
4384 public void announceForAccessibility(CharSequence text) {
4385 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4386 AccessibilityEvent event = AccessibilityEvent.obtain(
4387 AccessibilityEvent.TYPE_ANNOUNCEMENT);
4388 event.getText().add(text);
4389 sendAccessibilityEventUnchecked(event);
4390 }
4391 }
4392
4393 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004394 * @see #sendAccessibilityEvent(int)
4395 *
4396 * Note: Called from the default {@link AccessibilityDelegate}.
4397 */
4398 void sendAccessibilityEventInternal(int eventType) {
svetoslavganov75986cf2009-05-14 22:28:01 -07004399 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4400 sendAccessibilityEventUnchecked(AccessibilityEvent.obtain(eventType));
4401 }
4402 }
4403
4404 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07004405 * This method behaves exactly as {@link #sendAccessibilityEvent(int)} but
4406 * takes as an argument an empty {@link AccessibilityEvent} and does not
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004407 * perform a check whether accessibility is enabled.
4408 * <p>
4409 * If an {@link AccessibilityDelegate} has been specified via calling
4410 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4411 * {@link AccessibilityDelegate#sendAccessibilityEventUnchecked(View, AccessibilityEvent)}
4412 * is responsible for handling this call.
4413 * </p>
Svetoslav Ganov30401322011-05-12 18:53:45 -07004414 *
4415 * @param event The event to send.
4416 *
4417 * @see #sendAccessibilityEvent(int)
svetoslavganov75986cf2009-05-14 22:28:01 -07004418 */
4419 public void sendAccessibilityEventUnchecked(AccessibilityEvent event) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004420 if (mAccessibilityDelegate != null) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004421 mAccessibilityDelegate.sendAccessibilityEventUnchecked(this, event);
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004422 } else {
4423 sendAccessibilityEventUncheckedInternal(event);
4424 }
4425 }
4426
4427 /**
4428 * @see #sendAccessibilityEventUnchecked(AccessibilityEvent)
4429 *
4430 * Note: Called from the default {@link AccessibilityDelegate}.
4431 */
4432 void sendAccessibilityEventUncheckedInternal(AccessibilityEvent event) {
Svetoslav Ganov9cd1eca2011-01-13 14:24:02 -08004433 if (!isShown()) {
4434 return;
4435 }
Svetoslav Ganov30401322011-05-12 18:53:45 -07004436 onInitializeAccessibilityEvent(event);
Svetoslav Ganov82e236d2011-09-29 19:31:06 -07004437 // Only a subset of accessibility events populates text content.
4438 if ((event.getEventType() & POPULATING_ACCESSIBILITY_EVENT_TYPES) != 0) {
4439 dispatchPopulateAccessibilityEvent(event);
4440 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07004441 // Intercept accessibility focus events fired by virtual nodes to keep
4442 // track of accessibility focus position in such nodes.
4443 final int eventType = event.getEventType();
4444 switch (eventType) {
4445 case AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED: {
4446 final long virtualNodeId = AccessibilityNodeInfo.getVirtualDescendantId(
4447 event.getSourceNodeId());
4448 if (virtualNodeId != AccessibilityNodeInfo.UNDEFINED) {
4449 ViewRootImpl viewRootImpl = getViewRootImpl();
4450 if (viewRootImpl != null) {
4451 viewRootImpl.setAccessibilityFocusedHost(this);
4452 }
4453 }
4454 } break;
4455 case AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED: {
4456 final long virtualNodeId = AccessibilityNodeInfo.getVirtualDescendantId(
4457 event.getSourceNodeId());
4458 if (virtualNodeId != AccessibilityNodeInfo.UNDEFINED) {
4459 ViewRootImpl viewRootImpl = getViewRootImpl();
4460 if (viewRootImpl != null) {
4461 viewRootImpl.setAccessibilityFocusedHost(null);
4462 }
4463 }
4464 } break;
4465 }
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004466 // In the beginning we called #isShown(), so we know that getParent() is not null.
4467 getParent().requestSendAccessibilityEvent(this, event);
svetoslavganov75986cf2009-05-14 22:28:01 -07004468 }
4469
4470 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07004471 * Dispatches an {@link AccessibilityEvent} to the {@link View} first and then
4472 * to its children for adding their text content to the event. Note that the
4473 * event text is populated in a separate dispatch path since we add to the
4474 * event not only the text of the source but also the text of all its descendants.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004475 * A typical implementation will call
4476 * {@link #onPopulateAccessibilityEvent(AccessibilityEvent)} on the this view
4477 * and then call the {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)}
4478 * on each child. Override this method if custom population of the event text
4479 * content is required.
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004480 * <p>
4481 * If an {@link AccessibilityDelegate} has been specified via calling
4482 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4483 * {@link AccessibilityDelegate#dispatchPopulateAccessibilityEvent(View, AccessibilityEvent)}
4484 * is responsible for handling this call.
4485 * </p>
Svetoslav Ganov82e236d2011-09-29 19:31:06 -07004486 * <p>
4487 * <em>Note:</em> Accessibility events of certain types are not dispatched for
4488 * populating the event text via this method. For details refer to {@link AccessibilityEvent}.
4489 * </p>
svetoslavganov75986cf2009-05-14 22:28:01 -07004490 *
4491 * @param event The event.
4492 *
4493 * @return True if the event population was completed.
4494 */
4495 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004496 if (mAccessibilityDelegate != null) {
4497 return mAccessibilityDelegate.dispatchPopulateAccessibilityEvent(this, event);
4498 } else {
4499 return dispatchPopulateAccessibilityEventInternal(event);
4500 }
4501 }
4502
4503 /**
4504 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
4505 *
4506 * Note: Called from the default {@link AccessibilityDelegate}.
4507 */
4508 boolean dispatchPopulateAccessibilityEventInternal(AccessibilityEvent event) {
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004509 onPopulateAccessibilityEvent(event);
svetoslavganov75986cf2009-05-14 22:28:01 -07004510 return false;
4511 }
4512
4513 /**
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004514 * Called from {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)}
Svetoslav Ganov30401322011-05-12 18:53:45 -07004515 * giving a chance to this View to populate the accessibility event with its
Scott Mainb303d832011-10-12 16:45:18 -07004516 * text content. While this method is free to modify event
4517 * attributes other than text content, doing so should normally be performed in
Svetoslav Ganov30401322011-05-12 18:53:45 -07004518 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)}.
4519 * <p>
4520 * Example: Adding formatted date string to an accessibility event in addition
Scott Mainb303d832011-10-12 16:45:18 -07004521 * to the text added by the super implementation:
4522 * <pre> public void onPopulateAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov30401322011-05-12 18:53:45 -07004523 * super.onPopulateAccessibilityEvent(event);
4524 * final int flags = DateUtils.FORMAT_SHOW_DATE | DateUtils.FORMAT_SHOW_WEEKDAY;
4525 * String selectedDateUtterance = DateUtils.formatDateTime(mContext,
4526 * mCurrentDate.getTimeInMillis(), flags);
4527 * event.getText().add(selectedDateUtterance);
Scott Mainb303d832011-10-12 16:45:18 -07004528 * }</pre>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004529 * <p>
4530 * If an {@link AccessibilityDelegate} has been specified via calling
4531 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4532 * {@link AccessibilityDelegate#onPopulateAccessibilityEvent(View, AccessibilityEvent)}
4533 * is responsible for handling this call.
4534 * </p>
Scott Mainb303d832011-10-12 16:45:18 -07004535 * <p class="note"><strong>Note:</strong> Always call the super implementation before adding
4536 * information to the event, in case the default implementation has basic information to add.
4537 * </p>
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004538 *
4539 * @param event The accessibility event which to populate.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004540 *
4541 * @see #sendAccessibilityEvent(int)
4542 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004543 */
4544 public void onPopulateAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004545 if (mAccessibilityDelegate != null) {
4546 mAccessibilityDelegate.onPopulateAccessibilityEvent(this, event);
4547 } else {
4548 onPopulateAccessibilityEventInternal(event);
4549 }
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004550 }
4551
4552 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004553 * @see #onPopulateAccessibilityEvent(AccessibilityEvent)
4554 *
4555 * Note: Called from the default {@link AccessibilityDelegate}.
4556 */
4557 void onPopulateAccessibilityEventInternal(AccessibilityEvent event) {
4558
4559 }
4560
4561 /**
4562 * Initializes an {@link AccessibilityEvent} with information about
4563 * this View which is the event source. In other words, the source of
4564 * an accessibility event is the view whose state change triggered firing
4565 * the event.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004566 * <p>
4567 * Example: Setting the password property of an event in addition
Scott Mainb303d832011-10-12 16:45:18 -07004568 * to properties set by the super implementation:
4569 * <pre> public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
4570 * super.onInitializeAccessibilityEvent(event);
4571 * event.setPassword(true);
4572 * }</pre>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004573 * <p>
4574 * If an {@link AccessibilityDelegate} has been specified via calling
4575 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4576 * {@link AccessibilityDelegate#onInitializeAccessibilityEvent(View, AccessibilityEvent)}
4577 * is responsible for handling this call.
4578 * </p>
Scott Mainb303d832011-10-12 16:45:18 -07004579 * <p class="note"><strong>Note:</strong> Always call the super implementation before adding
4580 * information to the event, in case the default implementation has basic information to add.
4581 * </p>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004582 * @param event The event to initialize.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004583 *
4584 * @see #sendAccessibilityEvent(int)
4585 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
4586 */
4587 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004588 if (mAccessibilityDelegate != null) {
4589 mAccessibilityDelegate.onInitializeAccessibilityEvent(this, event);
4590 } else {
4591 onInitializeAccessibilityEventInternal(event);
4592 }
4593 }
4594
4595 /**
4596 * @see #onInitializeAccessibilityEvent(AccessibilityEvent)
4597 *
4598 * Note: Called from the default {@link AccessibilityDelegate}.
4599 */
4600 void onInitializeAccessibilityEventInternal(AccessibilityEvent event) {
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004601 event.setSource(this);
Svetoslav Ganov8a78fd42012-01-17 14:36:46 -08004602 event.setClassName(View.class.getName());
Svetoslav Ganov30401322011-05-12 18:53:45 -07004603 event.setPackageName(getContext().getPackageName());
4604 event.setEnabled(isEnabled());
4605 event.setContentDescription(mContentDescription);
4606
Svetoslav Ganovd9ee72f2011-10-05 22:26:05 -07004607 if (event.getEventType() == AccessibilityEvent.TYPE_VIEW_FOCUSED && mAttachInfo != null) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004608 ArrayList<View> focusablesTempList = mAttachInfo.mTempArrayList;
Svetoslav Ganovd9ee72f2011-10-05 22:26:05 -07004609 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD,
4610 FOCUSABLES_ALL);
4611 event.setItemCount(focusablesTempList.size());
4612 event.setCurrentItemIndex(focusablesTempList.indexOf(this));
4613 focusablesTempList.clear();
Svetoslav Ganov30401322011-05-12 18:53:45 -07004614 }
4615 }
4616
4617 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004618 * Returns an {@link AccessibilityNodeInfo} representing this view from the
4619 * point of view of an {@link android.accessibilityservice.AccessibilityService}.
4620 * This method is responsible for obtaining an accessibility node info from a
4621 * pool of reusable instances and calling
4622 * {@link #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} on this view to
4623 * initialize the former.
4624 * <p>
4625 * Note: The client is responsible for recycling the obtained instance by calling
4626 * {@link AccessibilityNodeInfo#recycle()} to minimize object creation.
4627 * </p>
Svetoslav Ganov02107852011-10-03 17:06:56 -07004628 *
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004629 * @return A populated {@link AccessibilityNodeInfo}.
4630 *
4631 * @see AccessibilityNodeInfo
4632 */
4633 public AccessibilityNodeInfo createAccessibilityNodeInfo() {
Svetoslav Ganov02107852011-10-03 17:06:56 -07004634 AccessibilityNodeProvider provider = getAccessibilityNodeProvider();
4635 if (provider != null) {
4636 return provider.createAccessibilityNodeInfo(View.NO_ID);
4637 } else {
4638 AccessibilityNodeInfo info = AccessibilityNodeInfo.obtain(this);
4639 onInitializeAccessibilityNodeInfo(info);
4640 return info;
4641 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004642 }
4643
4644 /**
4645 * Initializes an {@link AccessibilityNodeInfo} with information about this view.
4646 * The base implementation sets:
4647 * <ul>
4648 * <li>{@link AccessibilityNodeInfo#setParent(View)},</li>
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07004649 * <li>{@link AccessibilityNodeInfo#setBoundsInParent(Rect)},</li>
4650 * <li>{@link AccessibilityNodeInfo#setBoundsInScreen(Rect)},</li>
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004651 * <li>{@link AccessibilityNodeInfo#setPackageName(CharSequence)},</li>
4652 * <li>{@link AccessibilityNodeInfo#setClassName(CharSequence)},</li>
4653 * <li>{@link AccessibilityNodeInfo#setContentDescription(CharSequence)},</li>
4654 * <li>{@link AccessibilityNodeInfo#setEnabled(boolean)},</li>
4655 * <li>{@link AccessibilityNodeInfo#setClickable(boolean)},</li>
4656 * <li>{@link AccessibilityNodeInfo#setFocusable(boolean)},</li>
4657 * <li>{@link AccessibilityNodeInfo#setFocused(boolean)},</li>
4658 * <li>{@link AccessibilityNodeInfo#setLongClickable(boolean)},</li>
4659 * <li>{@link AccessibilityNodeInfo#setSelected(boolean)},</li>
4660 * </ul>
4661 * <p>
4662 * Subclasses should override this method, call the super implementation,
4663 * and set additional attributes.
4664 * </p>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004665 * <p>
4666 * If an {@link AccessibilityDelegate} has been specified via calling
4667 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4668 * {@link AccessibilityDelegate#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfo)}
4669 * is responsible for handling this call.
4670 * </p>
4671 *
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004672 * @param info The instance to initialize.
4673 */
4674 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004675 if (mAccessibilityDelegate != null) {
4676 mAccessibilityDelegate.onInitializeAccessibilityNodeInfo(this, info);
4677 } else {
4678 onInitializeAccessibilityNodeInfoInternal(info);
4679 }
4680 }
4681
4682 /**
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004683 * Gets the location of this view in screen coordintates.
4684 *
4685 * @param outRect The output location
4686 */
4687 private void getBoundsOnScreen(Rect outRect) {
4688 if (mAttachInfo == null) {
4689 return;
4690 }
4691
4692 RectF position = mAttachInfo.mTmpTransformRect;
Svetoslav Ganov14b2b742012-05-08 16:36:34 -07004693 position.set(0, 0, mRight - mLeft, mBottom - mTop);
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004694
4695 if (!hasIdentityMatrix()) {
4696 getMatrix().mapRect(position);
4697 }
4698
Svetoslav Ganov14b2b742012-05-08 16:36:34 -07004699 position.offset(mLeft, mTop);
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004700
4701 ViewParent parent = mParent;
4702 while (parent instanceof View) {
4703 View parentView = (View) parent;
4704
4705 position.offset(-parentView.mScrollX, -parentView.mScrollY);
4706
4707 if (!parentView.hasIdentityMatrix()) {
4708 parentView.getMatrix().mapRect(position);
4709 }
4710
4711 position.offset(parentView.mLeft, parentView.mTop);
4712
4713 parent = parentView.mParent;
4714 }
4715
4716 if (parent instanceof ViewRootImpl) {
4717 ViewRootImpl viewRootImpl = (ViewRootImpl) parent;
4718 position.offset(0, -viewRootImpl.mCurScrollY);
4719 }
4720
4721 position.offset(mAttachInfo.mWindowLeft, mAttachInfo.mWindowTop);
4722
4723 outRect.set((int) (position.left + 0.5f), (int) (position.top + 0.5f),
4724 (int) (position.right + 0.5f), (int) (position.bottom + 0.5f));
4725 }
4726
4727 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004728 * @see #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
4729 *
4730 * Note: Called from the default {@link AccessibilityDelegate}.
4731 */
4732 void onInitializeAccessibilityNodeInfoInternal(AccessibilityNodeInfo info) {
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004733 Rect bounds = mAttachInfo.mTmpInvalRect;
4734 getDrawingRect(bounds);
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07004735 info.setBoundsInParent(bounds);
4736
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004737 getBoundsOnScreen(bounds);
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07004738 info.setBoundsInScreen(bounds);
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004739
Svetoslav Ganovc406be92012-05-11 16:12:32 -07004740 ViewParent parent = getParentForAccessibility();
4741 if (parent instanceof View) {
4742 info.setParent((View) parent);
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004743 }
4744
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004745 info.setVisibleToUser(isVisibleToUser());
4746
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004747 info.setPackageName(mContext.getPackageName());
Svetoslav Ganov8a78fd42012-01-17 14:36:46 -08004748 info.setClassName(View.class.getName());
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004749 info.setContentDescription(getContentDescription());
4750
4751 info.setEnabled(isEnabled());
4752 info.setClickable(isClickable());
4753 info.setFocusable(isFocusable());
4754 info.setFocused(isFocused());
Svetoslav Ganov42138042012-03-20 11:51:39 -07004755 info.setAccessibilityFocused(isAccessibilityFocused());
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004756 info.setSelected(isSelected());
4757 info.setLongClickable(isLongClickable());
4758
4759 // TODO: These make sense only if we are in an AdapterView but all
4760 // views can be selected. Maybe from accessiiblity perspective
4761 // we should report as selectable view in an AdapterView.
4762 info.addAction(AccessibilityNodeInfo.ACTION_SELECT);
4763 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_SELECTION);
4764
4765 if (isFocusable()) {
4766 if (isFocused()) {
4767 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_FOCUS);
4768 } else {
4769 info.addAction(AccessibilityNodeInfo.ACTION_FOCUS);
4770 }
4771 }
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004772
Svetoslav Ganov02afe2c2012-05-07 17:51:59 -07004773 if (!isAccessibilityFocused()) {
4774 info.addAction(AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS);
4775 } else {
4776 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS);
4777 }
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004778
4779 if (isClickable()) {
4780 info.addAction(AccessibilityNodeInfo.ACTION_CLICK);
4781 }
4782
4783 if (isLongClickable()) {
4784 info.addAction(AccessibilityNodeInfo.ACTION_LONG_CLICK);
4785 }
4786
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07004787 if (mContentDescription != null && mContentDescription.length() > 0) {
Svetoslav Ganov2b435aa2012-05-04 17:16:37 -07004788 info.addAction(AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY);
4789 info.addAction(AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY);
4790 info.setMovementGranularities(AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07004791 | AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD
4792 | AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH);
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004793 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004794 }
4795
4796 /**
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004797 * Computes whether this view is visible to the user. Such a view is
4798 * attached, visible, all its predecessors are visible, it is not clipped
4799 * entirely by its predecessors, and has an alpha greater than zero.
Svetoslav Ganov749e7962012-04-19 17:13:46 -07004800 *
4801 * @return Whether the view is visible on the screen.
Guang Zhu0d607fb2012-05-11 19:34:56 -07004802 *
4803 * @hide
Svetoslav Ganov749e7962012-04-19 17:13:46 -07004804 */
Guang Zhu0d607fb2012-05-11 19:34:56 -07004805 protected boolean isVisibleToUser() {
4806 return isVisibleToUser(null);
4807 }
4808
4809 /**
4810 * Computes whether the given portion of this view is visible to the user. Such a view is
4811 * attached, visible, all its predecessors are visible, has an alpha greater than zero, and
4812 * the specified portion is not clipped entirely by its predecessors.
4813 *
4814 * @param boundInView the portion of the view to test; coordinates should be relative; may be
4815 * <code>null</code>, and the entire view will be tested in this case.
4816 * When <code>true</code> is returned by the function, the actual visible
4817 * region will be stored in this parameter; that is, if boundInView is fully
4818 * contained within the view, no modification will be made, otherwise regions
4819 * outside of the visible area of the view will be clipped.
4820 *
4821 * @return Whether the specified portion of the view is visible on the screen.
4822 *
4823 * @hide
4824 */
4825 protected boolean isVisibleToUser(Rect boundInView) {
4826 Rect visibleRect = mAttachInfo.mTmpInvalRect;
4827 Point offset = mAttachInfo.mPoint;
Svetoslav Ganov749e7962012-04-19 17:13:46 -07004828 // The first two checks are made also made by isShown() which
4829 // however traverses the tree up to the parent to catch that.
4830 // Therefore, we do some fail fast check to minimize the up
4831 // tree traversal.
Guang Zhu0d607fb2012-05-11 19:34:56 -07004832 boolean isVisible = mAttachInfo != null
4833 && mAttachInfo.mWindowVisibility == View.VISIBLE
4834 && getAlpha() > 0
4835 && isShown()
4836 && getGlobalVisibleRect(visibleRect, offset);
4837 if (isVisible && boundInView != null) {
4838 visibleRect.offset(-offset.x, -offset.y);
4839 isVisible &= boundInView.intersect(visibleRect);
4840 }
4841 return isVisible;
Svetoslav Ganov749e7962012-04-19 17:13:46 -07004842 }
4843
4844 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004845 * Sets a delegate for implementing accessibility support via compositon as
4846 * opposed to inheritance. The delegate's primary use is for implementing
4847 * backwards compatible widgets. For more details see {@link AccessibilityDelegate}.
4848 *
4849 * @param delegate The delegate instance.
4850 *
4851 * @see AccessibilityDelegate
4852 */
4853 public void setAccessibilityDelegate(AccessibilityDelegate delegate) {
4854 mAccessibilityDelegate = delegate;
4855 }
4856
4857 /**
Svetoslav Ganov02107852011-10-03 17:06:56 -07004858 * Gets the provider for managing a virtual view hierarchy rooted at this View
4859 * and reported to {@link android.accessibilityservice.AccessibilityService}s
4860 * that explore the window content.
4861 * <p>
4862 * If this method returns an instance, this instance is responsible for managing
4863 * {@link AccessibilityNodeInfo}s describing the virtual sub-tree rooted at this
4864 * View including the one representing the View itself. Similarly the returned
4865 * instance is responsible for performing accessibility actions on any virtual
4866 * view or the root view itself.
4867 * </p>
4868 * <p>
4869 * If an {@link AccessibilityDelegate} has been specified via calling
4870 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4871 * {@link AccessibilityDelegate#getAccessibilityNodeProvider(View)}
4872 * is responsible for handling this call.
4873 * </p>
4874 *
4875 * @return The provider.
4876 *
4877 * @see AccessibilityNodeProvider
4878 */
4879 public AccessibilityNodeProvider getAccessibilityNodeProvider() {
4880 if (mAccessibilityDelegate != null) {
4881 return mAccessibilityDelegate.getAccessibilityNodeProvider(this);
4882 } else {
4883 return null;
4884 }
4885 }
4886
4887 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004888 * Gets the unique identifier of this view on the screen for accessibility purposes.
4889 * If this {@link View} is not attached to any window, {@value #NO_ID} is returned.
4890 *
4891 * @return The view accessibility id.
4892 *
4893 * @hide
4894 */
4895 public int getAccessibilityViewId() {
4896 if (mAccessibilityViewId == NO_ID) {
4897 mAccessibilityViewId = sNextAccessibilityViewId++;
4898 }
4899 return mAccessibilityViewId;
4900 }
4901
4902 /**
4903 * Gets the unique identifier of the window in which this View reseides.
4904 *
4905 * @return The window accessibility id.
4906 *
4907 * @hide
4908 */
4909 public int getAccessibilityWindowId() {
4910 return mAttachInfo != null ? mAttachInfo.mAccessibilityWindowId : NO_ID;
4911 }
4912
4913 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07004914 * Gets the {@link View} description. It briefly describes the view and is
4915 * primarily used for accessibility support. Set this property to enable
4916 * better accessibility support for your application. This is especially
4917 * true for views that do not have textual representation (For example,
4918 * ImageButton).
4919 *
Svetoslav Ganov42138042012-03-20 11:51:39 -07004920 * @return The content description.
svetoslavganov75986cf2009-05-14 22:28:01 -07004921 *
4922 * @attr ref android.R.styleable#View_contentDescription
4923 */
Svetoslav Ganov42138042012-03-20 11:51:39 -07004924 @ViewDebug.ExportedProperty(category = "accessibility")
svetoslavganov75986cf2009-05-14 22:28:01 -07004925 public CharSequence getContentDescription() {
4926 return mContentDescription;
4927 }
4928
4929 /**
4930 * Sets the {@link View} description. It briefly describes the view and is
4931 * primarily used for accessibility support. Set this property to enable
4932 * better accessibility support for your application. This is especially
4933 * true for views that do not have textual representation (For example,
4934 * ImageButton).
4935 *
4936 * @param contentDescription The content description.
4937 *
4938 * @attr ref android.R.styleable#View_contentDescription
4939 */
Svetoslav Ganove261e282011-10-18 17:47:04 -07004940 @RemotableViewMethod
svetoslavganov75986cf2009-05-14 22:28:01 -07004941 public void setContentDescription(CharSequence contentDescription) {
4942 mContentDescription = contentDescription;
4943 }
4944
4945 /**
Romain Guya2431d02009-04-30 16:30:00 -07004946 * Invoked whenever this view loses focus, either by losing window focus or by losing
4947 * focus within its window. This method can be used to clear any state tied to the
4948 * focus. For instance, if a button is held pressed with the trackball and the window
4949 * loses focus, this method can be used to cancel the press.
4950 *
4951 * Subclasses of View overriding this method should always call super.onFocusLost().
4952 *
4953 * @see #onFocusChanged(boolean, int, android.graphics.Rect)
Romain Guy8506ab42009-06-11 17:35:47 -07004954 * @see #onWindowFocusChanged(boolean)
Romain Guya2431d02009-04-30 16:30:00 -07004955 *
4956 * @hide pending API council approval
4957 */
4958 protected void onFocusLost() {
4959 resetPressedState();
4960 }
4961
4962 private void resetPressedState() {
4963 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
4964 return;
4965 }
4966
4967 if (isPressed()) {
4968 setPressed(false);
4969
4970 if (!mHasPerformedLongPress) {
Maryam Garrett1549dd12009-12-15 16:06:36 -05004971 removeLongPressCallback();
Romain Guya2431d02009-04-30 16:30:00 -07004972 }
4973 }
4974 }
4975
4976 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004977 * Returns true if this view has focus
4978 *
4979 * @return True if this view has focus, false otherwise.
4980 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004981 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004982 public boolean isFocused() {
4983 return (mPrivateFlags & FOCUSED) != 0;
4984 }
4985
4986 /**
4987 * Find the view in the hierarchy rooted at this view that currently has
4988 * focus.
4989 *
4990 * @return The view that currently has focus, or null if no focused view can
4991 * be found.
4992 */
4993 public View findFocus() {
4994 return (mPrivateFlags & FOCUSED) != 0 ? this : null;
4995 }
4996
4997 /**
Philip Milne6c8ea062012-04-03 17:38:43 -07004998 * Indicates whether this view is one of the set of scrollable containers in
4999 * its window.
5000 *
5001 * @return whether this view is one of the set of scrollable containers in
5002 * its window
5003 *
5004 * @attr ref android.R.styleable#View_isScrollContainer
5005 */
5006 public boolean isScrollContainer() {
5007 return (mPrivateFlags & SCROLL_CONTAINER_ADDED) != 0;
5008 }
5009
5010 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005011 * Change whether this view is one of the set of scrollable containers in
5012 * its window. This will be used to determine whether the window can
5013 * resize or must pan when a soft input area is open -- scrollable
5014 * containers allow the window to use resize mode since the container
5015 * will appropriately shrink.
Philip Milne6c8ea062012-04-03 17:38:43 -07005016 *
5017 * @attr ref android.R.styleable#View_isScrollContainer
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005018 */
5019 public void setScrollContainer(boolean isScrollContainer) {
5020 if (isScrollContainer) {
5021 if (mAttachInfo != null && (mPrivateFlags&SCROLL_CONTAINER_ADDED) == 0) {
5022 mAttachInfo.mScrollContainers.add(this);
5023 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
5024 }
5025 mPrivateFlags |= SCROLL_CONTAINER;
5026 } else {
5027 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
5028 mAttachInfo.mScrollContainers.remove(this);
5029 }
5030 mPrivateFlags &= ~(SCROLL_CONTAINER|SCROLL_CONTAINER_ADDED);
5031 }
5032 }
5033
5034 /**
5035 * Returns the quality of the drawing cache.
5036 *
5037 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO},
5038 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
5039 *
5040 * @see #setDrawingCacheQuality(int)
5041 * @see #setDrawingCacheEnabled(boolean)
5042 * @see #isDrawingCacheEnabled()
5043 *
5044 * @attr ref android.R.styleable#View_drawingCacheQuality
5045 */
5046 public int getDrawingCacheQuality() {
5047 return mViewFlags & DRAWING_CACHE_QUALITY_MASK;
5048 }
5049
5050 /**
5051 * Set the drawing cache quality of this view. This value is used only when the
5052 * drawing cache is enabled
5053 *
5054 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO},
5055 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
5056 *
5057 * @see #getDrawingCacheQuality()
5058 * @see #setDrawingCacheEnabled(boolean)
5059 * @see #isDrawingCacheEnabled()
5060 *
5061 * @attr ref android.R.styleable#View_drawingCacheQuality
5062 */
5063 public void setDrawingCacheQuality(int quality) {
5064 setFlags(quality, DRAWING_CACHE_QUALITY_MASK);
5065 }
5066
5067 /**
5068 * Returns whether the screen should remain on, corresponding to the current
5069 * value of {@link #KEEP_SCREEN_ON}.
5070 *
5071 * @return Returns true if {@link #KEEP_SCREEN_ON} is set.
5072 *
5073 * @see #setKeepScreenOn(boolean)
5074 *
5075 * @attr ref android.R.styleable#View_keepScreenOn
5076 */
5077 public boolean getKeepScreenOn() {
5078 return (mViewFlags & KEEP_SCREEN_ON) != 0;
5079 }
5080
5081 /**
5082 * Controls whether the screen should remain on, modifying the
5083 * value of {@link #KEEP_SCREEN_ON}.
5084 *
5085 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}.
5086 *
5087 * @see #getKeepScreenOn()
5088 *
5089 * @attr ref android.R.styleable#View_keepScreenOn
5090 */
5091 public void setKeepScreenOn(boolean keepScreenOn) {
5092 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON);
5093 }
5094
5095 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005096 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
5097 * @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 -08005098 *
5099 * @attr ref android.R.styleable#View_nextFocusLeft
5100 */
5101 public int getNextFocusLeftId() {
5102 return mNextFocusLeftId;
5103 }
5104
5105 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005106 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
5107 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should
5108 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005109 *
5110 * @attr ref android.R.styleable#View_nextFocusLeft
5111 */
5112 public void setNextFocusLeftId(int nextFocusLeftId) {
5113 mNextFocusLeftId = nextFocusLeftId;
5114 }
5115
5116 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005117 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
5118 * @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 -08005119 *
5120 * @attr ref android.R.styleable#View_nextFocusRight
5121 */
5122 public int getNextFocusRightId() {
5123 return mNextFocusRightId;
5124 }
5125
5126 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005127 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
5128 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should
5129 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005130 *
5131 * @attr ref android.R.styleable#View_nextFocusRight
5132 */
5133 public void setNextFocusRightId(int nextFocusRightId) {
5134 mNextFocusRightId = nextFocusRightId;
5135 }
5136
5137 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005138 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}.
5139 * @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 -08005140 *
5141 * @attr ref android.R.styleable#View_nextFocusUp
5142 */
5143 public int getNextFocusUpId() {
5144 return mNextFocusUpId;
5145 }
5146
5147 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005148 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}.
5149 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should
5150 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005151 *
5152 * @attr ref android.R.styleable#View_nextFocusUp
5153 */
5154 public void setNextFocusUpId(int nextFocusUpId) {
5155 mNextFocusUpId = nextFocusUpId;
5156 }
5157
5158 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005159 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
5160 * @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 -08005161 *
5162 * @attr ref android.R.styleable#View_nextFocusDown
5163 */
5164 public int getNextFocusDownId() {
5165 return mNextFocusDownId;
5166 }
5167
5168 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005169 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
5170 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should
5171 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005172 *
5173 * @attr ref android.R.styleable#View_nextFocusDown
5174 */
5175 public void setNextFocusDownId(int nextFocusDownId) {
5176 mNextFocusDownId = nextFocusDownId;
5177 }
5178
5179 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005180 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
5181 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
5182 *
5183 * @attr ref android.R.styleable#View_nextFocusForward
5184 */
5185 public int getNextFocusForwardId() {
5186 return mNextFocusForwardId;
5187 }
5188
5189 /**
5190 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
5191 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should
5192 * decide automatically.
5193 *
5194 * @attr ref android.R.styleable#View_nextFocusForward
5195 */
5196 public void setNextFocusForwardId(int nextFocusForwardId) {
5197 mNextFocusForwardId = nextFocusForwardId;
5198 }
5199
5200 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005201 * Returns the visibility of this view and all of its ancestors
5202 *
5203 * @return True if this view and all of its ancestors are {@link #VISIBLE}
5204 */
5205 public boolean isShown() {
5206 View current = this;
5207 //noinspection ConstantConditions
5208 do {
5209 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) {
5210 return false;
5211 }
5212 ViewParent parent = current.mParent;
5213 if (parent == null) {
5214 return false; // We are not attached to the view root
5215 }
5216 if (!(parent instanceof View)) {
5217 return true;
5218 }
5219 current = (View) parent;
5220 } while (current != null);
5221
5222 return false;
5223 }
5224
5225 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005226 * Called by the view hierarchy when the content insets for a window have
5227 * changed, to allow it to adjust its content to fit within those windows.
5228 * The content insets tell you the space that the status bar, input method,
5229 * and other system windows infringe on the application's window.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005230 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005231 * <p>You do not normally need to deal with this function, since the default
5232 * window decoration given to applications takes care of applying it to the
5233 * content of the window. If you use {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}
5234 * or {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION} this will not be the case,
5235 * and your content can be placed under those system elements. You can then
5236 * use this method within your view hierarchy if you have parts of your UI
5237 * which you would like to ensure are not being covered.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005238 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005239 * <p>The default implementation of this method simply applies the content
5240 * inset's to the view's padding. This can be enabled through
5241 * {@link #setFitsSystemWindows(boolean)}. Alternatively, you can override
5242 * the method and handle the insets however you would like. Note that the
5243 * insets provided by the framework are always relative to the far edges
5244 * of the window, not accounting for the location of the called view within
5245 * that window. (In fact when this method is called you do not yet know
5246 * where the layout will place the view, as it is done before layout happens.)
5247 *
5248 * <p>Note: unlike many View methods, there is no dispatch phase to this
5249 * call. If you are overriding it in a ViewGroup and want to allow the
5250 * call to continue to your children, you must be sure to call the super
5251 * implementation.
5252 *
Dianne Hackborncf675782012-05-10 15:07:24 -07005253 * <p>Here is a sample layout that makes use of fitting system windows
5254 * to have controls for a video view placed inside of the window decorations
5255 * that it hides and shows. This can be used with code like the second
5256 * sample (video player) shown in {@link #setSystemUiVisibility(int)}.
5257 *
5258 * {@sample development/samples/ApiDemos/res/layout/video_player.xml complete}
5259 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005260 * @param insets Current content insets of the window. Prior to
5261 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN} you must not modify
5262 * the insets or else you and Android will be unhappy.
5263 *
5264 * @return Return true if this view applied the insets and it should not
5265 * continue propagating further down the hierarchy, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005266 */
5267 protected boolean fitSystemWindows(Rect insets) {
5268 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) {
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005269 mUserPaddingStart = -1;
5270 mUserPaddingEnd = -1;
5271 mUserPaddingRelative = false;
5272 if ((mViewFlags & OPTIONAL_FITS_SYSTEM_WINDOWS) == 0
5273 || mAttachInfo == null
5274 || (mAttachInfo.mSystemUiVisibility & SYSTEM_UI_LAYOUT_FLAGS) == 0) {
5275 internalSetPadding(insets.left, insets.top, insets.right, insets.bottom);
5276 return true;
5277 } else {
5278 internalSetPadding(0, 0, 0, 0);
5279 return false;
5280 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005281 }
5282 return false;
5283 }
5284
5285 /**
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005286 * Set whether or not this view should account for system screen decorations
5287 * such as the status bar and inset its content. This allows this view to be
5288 * positioned in absolute screen coordinates and remain visible to the user.
5289 *
5290 * <p>This should only be used by top-level window decor views.
5291 *
5292 * @param fitSystemWindows true to inset content for system screen decorations, false for
5293 * default behavior.
5294 *
5295 * @attr ref android.R.styleable#View_fitsSystemWindows
5296 */
5297 public void setFitsSystemWindows(boolean fitSystemWindows) {
5298 setFlags(fitSystemWindows ? FITS_SYSTEM_WINDOWS : 0, FITS_SYSTEM_WINDOWS);
5299 }
5300
5301 /**
Dianne Hackborncf675782012-05-10 15:07:24 -07005302 * Check for state of {@link #setFitsSystemWindows(boolean). If this method
5303 * returns true, this view
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005304 * will account for system screen decorations such as the status bar and inset its
5305 * content. This allows the view to be positioned in absolute screen coordinates
5306 * and remain visible to the user.
5307 *
5308 * @return true if this view will adjust its content bounds for system screen decorations.
5309 *
5310 * @attr ref android.R.styleable#View_fitsSystemWindows
5311 */
Dianne Hackborncf675782012-05-10 15:07:24 -07005312 public boolean getFitsSystemWindows() {
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005313 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS;
5314 }
5315
Dianne Hackbornb1b55e62012-05-10 16:25:54 -07005316 /** @hide */
5317 public boolean fitsSystemWindows() {
5318 return getFitsSystemWindows();
5319 }
5320
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005321 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005322 * Ask that a new dispatch of {@link #fitSystemWindows(Rect)} be performed.
5323 */
5324 public void requestFitSystemWindows() {
5325 if (mParent != null) {
5326 mParent.requestFitSystemWindows();
5327 }
5328 }
5329
5330 /**
5331 * For use by PhoneWindow to make its own system window fitting optional.
5332 * @hide
5333 */
5334 public void makeOptionalFitsSystemWindows() {
5335 setFlags(OPTIONAL_FITS_SYSTEM_WINDOWS, OPTIONAL_FITS_SYSTEM_WINDOWS);
5336 }
5337
5338 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005339 * Returns the visibility status for this view.
5340 *
5341 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
5342 * @attr ref android.R.styleable#View_visibility
5343 */
5344 @ViewDebug.ExportedProperty(mapping = {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07005345 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"),
5346 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"),
5347 @ViewDebug.IntToString(from = GONE, to = "GONE")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005348 })
5349 public int getVisibility() {
5350 return mViewFlags & VISIBILITY_MASK;
5351 }
5352
5353 /**
5354 * Set the enabled state of this view.
5355 *
5356 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
5357 * @attr ref android.R.styleable#View_visibility
5358 */
5359 @RemotableViewMethod
5360 public void setVisibility(int visibility) {
5361 setFlags(visibility, VISIBILITY_MASK);
Philip Milne6c8ea062012-04-03 17:38:43 -07005362 if (mBackground != null) mBackground.setVisible(visibility == VISIBLE, false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005363 }
5364
5365 /**
5366 * Returns the enabled status for this view. The interpretation of the
5367 * enabled state varies by subclass.
5368 *
5369 * @return True if this view is enabled, false otherwise.
5370 */
5371 @ViewDebug.ExportedProperty
5372 public boolean isEnabled() {
5373 return (mViewFlags & ENABLED_MASK) == ENABLED;
5374 }
5375
5376 /**
5377 * Set the enabled state of this view. The interpretation of the enabled
5378 * state varies by subclass.
5379 *
5380 * @param enabled True if this view is enabled, false otherwise.
5381 */
Jeff Sharkey2b95c242010-02-08 17:40:30 -08005382 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005383 public void setEnabled(boolean enabled) {
Amith Yamasania2ef00b2009-07-30 16:14:34 -07005384 if (enabled == isEnabled()) return;
5385
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005386 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK);
5387
5388 /*
5389 * The View most likely has to change its appearance, so refresh
5390 * the drawable state.
5391 */
5392 refreshDrawableState();
5393
5394 // Invalidate too, since the default behavior for views is to be
5395 // be drawn at 50% alpha rather than to change the drawable.
Romain Guy0fd89bf2011-01-26 15:41:30 -08005396 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005397 }
5398
5399 /**
5400 * Set whether this view can receive the focus.
5401 *
5402 * Setting this to false will also ensure that this view is not focusable
5403 * in touch mode.
5404 *
5405 * @param focusable If true, this view can receive the focus.
5406 *
5407 * @see #setFocusableInTouchMode(boolean)
5408 * @attr ref android.R.styleable#View_focusable
5409 */
5410 public void setFocusable(boolean focusable) {
5411 if (!focusable) {
5412 setFlags(0, FOCUSABLE_IN_TOUCH_MODE);
5413 }
5414 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK);
5415 }
5416
5417 /**
5418 * Set whether this view can receive focus while in touch mode.
5419 *
5420 * Setting this to true will also ensure that this view is focusable.
5421 *
5422 * @param focusableInTouchMode If true, this view can receive the focus while
5423 * in touch mode.
5424 *
5425 * @see #setFocusable(boolean)
5426 * @attr ref android.R.styleable#View_focusableInTouchMode
5427 */
5428 public void setFocusableInTouchMode(boolean focusableInTouchMode) {
5429 // Focusable in touch mode should always be set before the focusable flag
5430 // otherwise, setting the focusable flag will trigger a focusableViewAvailable()
5431 // which, in touch mode, will not successfully request focus on this view
5432 // because the focusable in touch mode flag is not set
5433 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE);
5434 if (focusableInTouchMode) {
5435 setFlags(FOCUSABLE, FOCUSABLE_MASK);
5436 }
5437 }
5438
5439 /**
5440 * Set whether this view should have sound effects enabled for events such as
5441 * clicking and touching.
5442 *
5443 * <p>You may wish to disable sound effects for a view if you already play sounds,
5444 * for instance, a dial key that plays dtmf tones.
5445 *
5446 * @param soundEffectsEnabled whether sound effects are enabled for this view.
5447 * @see #isSoundEffectsEnabled()
5448 * @see #playSoundEffect(int)
5449 * @attr ref android.R.styleable#View_soundEffectsEnabled
5450 */
5451 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) {
5452 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED);
5453 }
5454
5455 /**
5456 * @return whether this view should have sound effects enabled for events such as
5457 * clicking and touching.
5458 *
5459 * @see #setSoundEffectsEnabled(boolean)
5460 * @see #playSoundEffect(int)
5461 * @attr ref android.R.styleable#View_soundEffectsEnabled
5462 */
5463 @ViewDebug.ExportedProperty
5464 public boolean isSoundEffectsEnabled() {
5465 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED);
5466 }
5467
5468 /**
5469 * Set whether this view should have haptic feedback for events such as
5470 * long presses.
5471 *
5472 * <p>You may wish to disable haptic feedback if your view already controls
5473 * its own haptic feedback.
5474 *
5475 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view.
5476 * @see #isHapticFeedbackEnabled()
5477 * @see #performHapticFeedback(int)
5478 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
5479 */
5480 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) {
5481 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED);
5482 }
5483
5484 /**
5485 * @return whether this view should have haptic feedback enabled for events
5486 * long presses.
5487 *
5488 * @see #setHapticFeedbackEnabled(boolean)
5489 * @see #performHapticFeedback(int)
5490 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
5491 */
5492 @ViewDebug.ExportedProperty
5493 public boolean isHapticFeedbackEnabled() {
5494 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED);
5495 }
5496
5497 /**
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005498 * Returns the layout direction for this view.
Cibu Johny7632cb92010-02-22 13:01:02 -08005499 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005500 * @return One of {@link #LAYOUT_DIRECTION_LTR},
5501 * {@link #LAYOUT_DIRECTION_RTL},
5502 * {@link #LAYOUT_DIRECTION_INHERIT} or
5503 * {@link #LAYOUT_DIRECTION_LOCALE}.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005504 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005505 * @attr ref android.R.styleable#View_layoutDirection
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005506 * @hide
Cibu Johny7632cb92010-02-22 13:01:02 -08005507 */
Fabrice Di Megliobce84d22011-06-02 15:57:01 -07005508 @ViewDebug.ExportedProperty(category = "layout", mapping = {
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005509 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "LTR"),
5510 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RTL"),
5511 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_INHERIT, to = "INHERIT"),
5512 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LOCALE, to = "LOCALE")
Cibu Johny7632cb92010-02-22 13:01:02 -08005513 })
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005514 public int getLayoutDirection() {
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005515 return (mPrivateFlags2 & LAYOUT_DIRECTION_MASK) >> LAYOUT_DIRECTION_MASK_SHIFT;
Cibu Johny7632cb92010-02-22 13:01:02 -08005516 }
5517
5518 /**
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005519 * Set the layout direction for this view. This will propagate a reset of layout direction
5520 * resolution to the view's children and resolve layout direction for this view.
Cibu Johny7632cb92010-02-22 13:01:02 -08005521 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005522 * @param layoutDirection One of {@link #LAYOUT_DIRECTION_LTR},
5523 * {@link #LAYOUT_DIRECTION_RTL},
5524 * {@link #LAYOUT_DIRECTION_INHERIT} or
5525 * {@link #LAYOUT_DIRECTION_LOCALE}.
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005526 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005527 * @attr ref android.R.styleable#View_layoutDirection
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005528 * @hide
Cibu Johny7632cb92010-02-22 13:01:02 -08005529 */
5530 @RemotableViewMethod
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005531 public void setLayoutDirection(int layoutDirection) {
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005532 if (getLayoutDirection() != layoutDirection) {
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -07005533 // Reset the current layout direction and the resolved one
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005534 mPrivateFlags2 &= ~LAYOUT_DIRECTION_MASK;
Fabrice Di Meglio7f86c802011-07-01 15:09:24 -07005535 resetResolvedLayoutDirection();
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005536 // Set the new layout direction (filtered) and ask for a layout pass
5537 mPrivateFlags2 |=
5538 ((layoutDirection << LAYOUT_DIRECTION_MASK_SHIFT) & LAYOUT_DIRECTION_MASK);
5539 requestLayout();
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005540 }
Cibu Johny7632cb92010-02-22 13:01:02 -08005541 }
5542
5543 /**
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005544 * Returns the resolved layout direction for this view.
5545 *
5546 * @return {@link #LAYOUT_DIRECTION_RTL} if the layout direction is RTL or returns
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005547 * {@link #LAYOUT_DIRECTION_LTR} if the layout direction is not RTL.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005548 * @hide
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005549 */
5550 @ViewDebug.ExportedProperty(category = "layout", mapping = {
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005551 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "RESOLVED_DIRECTION_LTR"),
5552 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RESOLVED_DIRECTION_RTL")
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005553 })
5554 public int getResolvedLayoutDirection() {
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -07005555 // The layout diretion will be resolved only if needed
5556 if ((mPrivateFlags2 & LAYOUT_DIRECTION_RESOLVED) != LAYOUT_DIRECTION_RESOLVED) {
5557 resolveLayoutDirection();
5558 }
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07005559 return ((mPrivateFlags2 & LAYOUT_DIRECTION_RESOLVED_RTL) == LAYOUT_DIRECTION_RESOLVED_RTL) ?
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005560 LAYOUT_DIRECTION_RTL : LAYOUT_DIRECTION_LTR;
5561 }
5562
5563 /**
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005564 * Indicates whether or not this view's layout is right-to-left. This is resolved from
5565 * layout attribute and/or the inherited value from the parent
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005566 *
5567 * @return true if the layout is right-to-left.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005568 * @hide
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005569 */
5570 @ViewDebug.ExportedProperty(category = "layout")
5571 public boolean isLayoutRtl() {
5572 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL);
5573 }
5574
5575 /**
Adam Powell539ee872012-02-03 19:00:49 -08005576 * Indicates whether the view is currently tracking transient state that the
5577 * app should not need to concern itself with saving and restoring, but that
5578 * the framework should take special note to preserve when possible.
5579 *
Adam Powell785c4472012-05-02 21:25:39 -07005580 * <p>A view with transient state cannot be trivially rebound from an external
5581 * data source, such as an adapter binding item views in a list. This may be
5582 * because the view is performing an animation, tracking user selection
5583 * of content, or similar.</p>
5584 *
Adam Powell539ee872012-02-03 19:00:49 -08005585 * @return true if the view has transient state
Adam Powell539ee872012-02-03 19:00:49 -08005586 */
5587 @ViewDebug.ExportedProperty(category = "layout")
5588 public boolean hasTransientState() {
5589 return (mPrivateFlags2 & HAS_TRANSIENT_STATE) == HAS_TRANSIENT_STATE;
5590 }
5591
5592 /**
5593 * Set whether this view is currently tracking transient state that the
Chet Haase563d4f22012-04-18 16:20:08 -07005594 * framework should attempt to preserve when possible. This flag is reference counted,
5595 * so every call to setHasTransientState(true) should be paired with a later call
5596 * to setHasTransientState(false).
Adam Powell539ee872012-02-03 19:00:49 -08005597 *
Adam Powell785c4472012-05-02 21:25:39 -07005598 * <p>A view with transient state cannot be trivially rebound from an external
5599 * data source, such as an adapter binding item views in a list. This may be
5600 * because the view is performing an animation, tracking user selection
5601 * of content, or similar.</p>
5602 *
Adam Powell539ee872012-02-03 19:00:49 -08005603 * @param hasTransientState true if this view has transient state
Adam Powell539ee872012-02-03 19:00:49 -08005604 */
5605 public void setHasTransientState(boolean hasTransientState) {
Chet Haase563d4f22012-04-18 16:20:08 -07005606 mTransientStateCount = hasTransientState ? mTransientStateCount + 1 :
5607 mTransientStateCount - 1;
5608 if (mTransientStateCount < 0) {
5609 mTransientStateCount = 0;
5610 Log.e(VIEW_LOG_TAG, "hasTransientState decremented below 0: " +
5611 "unmatched pair of setHasTransientState calls");
5612 }
5613 if ((hasTransientState && mTransientStateCount == 1) ||
Adam Powell057a5852012-05-11 10:28:38 -07005614 (!hasTransientState && mTransientStateCount == 0)) {
Chet Haase563d4f22012-04-18 16:20:08 -07005615 // update flag if we've just incremented up from 0 or decremented down to 0
5616 mPrivateFlags2 = (mPrivateFlags2 & ~HAS_TRANSIENT_STATE) |
5617 (hasTransientState ? HAS_TRANSIENT_STATE : 0);
5618 if (mParent != null) {
5619 try {
5620 mParent.childHasTransientStateChanged(this, hasTransientState);
5621 } catch (AbstractMethodError e) {
5622 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() +
5623 " does not fully implement ViewParent", e);
5624 }
Adam Powell539ee872012-02-03 19:00:49 -08005625 }
5626 }
5627 }
5628
5629 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005630 * If this view doesn't do any drawing on its own, set this flag to
5631 * allow further optimizations. By default, this flag is not set on
5632 * View, but could be set on some View subclasses such as ViewGroup.
5633 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07005634 * Typically, if you override {@link #onDraw(android.graphics.Canvas)}
5635 * you should clear this flag.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005636 *
5637 * @param willNotDraw whether or not this View draw on its own
5638 */
5639 public void setWillNotDraw(boolean willNotDraw) {
5640 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK);
5641 }
5642
5643 /**
5644 * Returns whether or not this View draws on its own.
5645 *
5646 * @return true if this view has nothing to draw, false otherwise
5647 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005648 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005649 public boolean willNotDraw() {
5650 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW;
5651 }
5652
5653 /**
5654 * When a View's drawing cache is enabled, drawing is redirected to an
5655 * offscreen bitmap. Some views, like an ImageView, must be able to
5656 * bypass this mechanism if they already draw a single bitmap, to avoid
5657 * unnecessary usage of the memory.
5658 *
5659 * @param willNotCacheDrawing true if this view does not cache its
5660 * drawing, false otherwise
5661 */
5662 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) {
5663 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING);
5664 }
5665
5666 /**
5667 * Returns whether or not this View can cache its drawing or not.
5668 *
5669 * @return true if this view does not cache its drawing, false otherwise
5670 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005671 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005672 public boolean willNotCacheDrawing() {
5673 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING;
5674 }
5675
5676 /**
5677 * Indicates whether this view reacts to click events or not.
5678 *
5679 * @return true if the view is clickable, false otherwise
5680 *
5681 * @see #setClickable(boolean)
5682 * @attr ref android.R.styleable#View_clickable
5683 */
5684 @ViewDebug.ExportedProperty
5685 public boolean isClickable() {
5686 return (mViewFlags & CLICKABLE) == CLICKABLE;
5687 }
5688
5689 /**
5690 * Enables or disables click events for this view. When a view
5691 * is clickable it will change its state to "pressed" on every click.
5692 * Subclasses should set the view clickable to visually react to
5693 * user's clicks.
5694 *
5695 * @param clickable true to make the view clickable, false otherwise
5696 *
5697 * @see #isClickable()
5698 * @attr ref android.R.styleable#View_clickable
5699 */
5700 public void setClickable(boolean clickable) {
5701 setFlags(clickable ? CLICKABLE : 0, CLICKABLE);
5702 }
5703
5704 /**
5705 * Indicates whether this view reacts to long click events or not.
5706 *
5707 * @return true if the view is long clickable, false otherwise
5708 *
5709 * @see #setLongClickable(boolean)
5710 * @attr ref android.R.styleable#View_longClickable
5711 */
5712 public boolean isLongClickable() {
5713 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
5714 }
5715
5716 /**
5717 * Enables or disables long click events for this view. When a view is long
5718 * clickable it reacts to the user holding down the button for a longer
5719 * duration than a tap. This event can either launch the listener or a
5720 * context menu.
5721 *
5722 * @param longClickable true to make the view long clickable, false otherwise
5723 * @see #isLongClickable()
5724 * @attr ref android.R.styleable#View_longClickable
5725 */
5726 public void setLongClickable(boolean longClickable) {
5727 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE);
5728 }
5729
5730 /**
Chet Haase49afa5b2010-08-23 11:39:53 -07005731 * Sets the pressed state for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005732 *
5733 * @see #isClickable()
5734 * @see #setClickable(boolean)
5735 *
5736 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts
5737 * the View's internal state from a previously set "pressed" state.
5738 */
5739 public void setPressed(boolean pressed) {
Adam Powell035a1fc2012-02-27 15:23:50 -08005740 final boolean needsRefresh = pressed != ((mPrivateFlags & PRESSED) == PRESSED);
Adam Powell4d6f0662012-02-21 15:11:11 -08005741
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005742 if (pressed) {
5743 mPrivateFlags |= PRESSED;
5744 } else {
5745 mPrivateFlags &= ~PRESSED;
5746 }
Adam Powell035a1fc2012-02-27 15:23:50 -08005747
5748 if (needsRefresh) {
5749 refreshDrawableState();
5750 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005751 dispatchSetPressed(pressed);
5752 }
5753
5754 /**
5755 * Dispatch setPressed to all of this View's children.
5756 *
5757 * @see #setPressed(boolean)
5758 *
5759 * @param pressed The new pressed state
5760 */
5761 protected void dispatchSetPressed(boolean pressed) {
5762 }
5763
5764 /**
5765 * Indicates whether the view is currently in pressed state. Unless
5766 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter
5767 * the pressed state.
5768 *
Philip Milne6c8ea062012-04-03 17:38:43 -07005769 * @see #setPressed(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005770 * @see #isClickable()
5771 * @see #setClickable(boolean)
5772 *
5773 * @return true if the view is currently pressed, false otherwise
5774 */
5775 public boolean isPressed() {
5776 return (mPrivateFlags & PRESSED) == PRESSED;
5777 }
5778
5779 /**
5780 * Indicates whether this view will save its state (that is,
5781 * whether its {@link #onSaveInstanceState} method will be called).
5782 *
5783 * @return Returns true if the view state saving is enabled, else false.
5784 *
5785 * @see #setSaveEnabled(boolean)
5786 * @attr ref android.R.styleable#View_saveEnabled
5787 */
5788 public boolean isSaveEnabled() {
5789 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED;
5790 }
5791
5792 /**
5793 * Controls whether the saving of this view's state is
5794 * enabled (that is, whether its {@link #onSaveInstanceState} method
5795 * will be called). Note that even if freezing is enabled, the
Romain Guy5c22a8c2011-05-13 11:48:45 -07005796 * view still must have an id assigned to it (via {@link #setId(int)})
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005797 * for its state to be saved. This flag can only disable the
5798 * saving of this view; any child views may still have their state saved.
5799 *
5800 * @param enabled Set to false to <em>disable</em> state saving, or true
5801 * (the default) to allow it.
5802 *
5803 * @see #isSaveEnabled()
5804 * @see #setId(int)
5805 * @see #onSaveInstanceState()
5806 * @attr ref android.R.styleable#View_saveEnabled
5807 */
5808 public void setSaveEnabled(boolean enabled) {
5809 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK);
5810 }
5811
Jeff Brown85a31762010-09-01 17:01:00 -07005812 /**
5813 * Gets whether the framework should discard touches when the view's
5814 * window is obscured by another visible window.
5815 * Refer to the {@link View} security documentation for more details.
5816 *
5817 * @return True if touch filtering is enabled.
5818 *
5819 * @see #setFilterTouchesWhenObscured(boolean)
5820 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
5821 */
5822 @ViewDebug.ExportedProperty
5823 public boolean getFilterTouchesWhenObscured() {
5824 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0;
5825 }
5826
5827 /**
5828 * Sets whether the framework should discard touches when the view's
5829 * window is obscured by another visible window.
5830 * Refer to the {@link View} security documentation for more details.
5831 *
5832 * @param enabled True if touch filtering should be enabled.
5833 *
5834 * @see #getFilterTouchesWhenObscured
5835 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
5836 */
5837 public void setFilterTouchesWhenObscured(boolean enabled) {
5838 setFlags(enabled ? 0 : FILTER_TOUCHES_WHEN_OBSCURED,
5839 FILTER_TOUCHES_WHEN_OBSCURED);
5840 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005841
5842 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07005843 * Indicates whether the entire hierarchy under this view will save its
5844 * state when a state saving traversal occurs from its parent. The default
5845 * is true; if false, these views will not be saved unless
5846 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
5847 *
5848 * @return Returns true if the view state saving from parent is enabled, else false.
5849 *
5850 * @see #setSaveFromParentEnabled(boolean)
5851 */
5852 public boolean isSaveFromParentEnabled() {
5853 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED;
5854 }
5855
5856 /**
5857 * Controls whether the entire hierarchy under this view will save its
5858 * state when a state saving traversal occurs from its parent. The default
5859 * is true; if false, these views will not be saved unless
5860 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
5861 *
5862 * @param enabled Set to false to <em>disable</em> state saving, or true
5863 * (the default) to allow it.
5864 *
5865 * @see #isSaveFromParentEnabled()
5866 * @see #setId(int)
5867 * @see #onSaveInstanceState()
5868 */
5869 public void setSaveFromParentEnabled(boolean enabled) {
5870 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK);
5871 }
5872
5873
5874 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005875 * Returns whether this View is able to take focus.
5876 *
5877 * @return True if this view can take focus, or false otherwise.
5878 * @attr ref android.R.styleable#View_focusable
5879 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005880 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005881 public final boolean isFocusable() {
5882 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK);
5883 }
5884
5885 /**
5886 * When a view is focusable, it may not want to take focus when in touch mode.
5887 * For example, a button would like focus when the user is navigating via a D-pad
5888 * so that the user can click on it, but once the user starts touching the screen,
5889 * the button shouldn't take focus
5890 * @return Whether the view is focusable in touch mode.
5891 * @attr ref android.R.styleable#View_focusableInTouchMode
5892 */
5893 @ViewDebug.ExportedProperty
5894 public final boolean isFocusableInTouchMode() {
5895 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE);
5896 }
5897
5898 /**
5899 * Find the nearest view in the specified direction that can take focus.
5900 * This does not actually give focus to that view.
5901 *
5902 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
5903 *
5904 * @return The nearest focusable in the specified direction, or null if none
5905 * can be found.
5906 */
5907 public View focusSearch(int direction) {
5908 if (mParent != null) {
5909 return mParent.focusSearch(this, direction);
5910 } else {
5911 return null;
5912 }
5913 }
5914
5915 /**
5916 * This method is the last chance for the focused view and its ancestors to
5917 * respond to an arrow key. This is called when the focused view did not
5918 * consume the key internally, nor could the view system find a new view in
5919 * the requested direction to give focus to.
5920 *
5921 * @param focused The currently focused view.
5922 * @param direction The direction focus wants to move. One of FOCUS_UP,
5923 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT.
5924 * @return True if the this view consumed this unhandled move.
5925 */
5926 public boolean dispatchUnhandledMove(View focused, int direction) {
5927 return false;
5928 }
5929
5930 /**
5931 * If a user manually specified the next view id for a particular direction,
Jeff Brown4e6319b2010-12-13 10:36:51 -08005932 * use the root to look up the view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005933 * @param root The root view of the hierarchy containing this view.
Jeff Brown4e6319b2010-12-13 10:36:51 -08005934 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD,
5935 * or FOCUS_BACKWARD.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005936 * @return The user specified next view, or null if there is none.
5937 */
5938 View findUserSetNextFocus(View root, int direction) {
5939 switch (direction) {
5940 case FOCUS_LEFT:
5941 if (mNextFocusLeftId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005942 return findViewInsideOutShouldExist(root, mNextFocusLeftId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005943 case FOCUS_RIGHT:
5944 if (mNextFocusRightId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005945 return findViewInsideOutShouldExist(root, mNextFocusRightId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005946 case FOCUS_UP:
5947 if (mNextFocusUpId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005948 return findViewInsideOutShouldExist(root, mNextFocusUpId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005949 case FOCUS_DOWN:
5950 if (mNextFocusDownId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005951 return findViewInsideOutShouldExist(root, mNextFocusDownId);
Jeff Brown4e6319b2010-12-13 10:36:51 -08005952 case FOCUS_FORWARD:
5953 if (mNextFocusForwardId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005954 return findViewInsideOutShouldExist(root, mNextFocusForwardId);
Jeff Brown4e6319b2010-12-13 10:36:51 -08005955 case FOCUS_BACKWARD: {
John Reck1ecebbb2012-03-06 16:08:54 -08005956 if (mID == View.NO_ID) return null;
Jeff Brown4e6319b2010-12-13 10:36:51 -08005957 final int id = mID;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005958 return root.findViewByPredicateInsideOut(this, new Predicate<View>() {
Jeff Brown4e6319b2010-12-13 10:36:51 -08005959 @Override
5960 public boolean apply(View t) {
5961 return t.mNextFocusForwardId == id;
5962 }
5963 });
5964 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005965 }
5966 return null;
5967 }
5968
Jeff Brown4dfbec22011-08-15 14:55:37 -07005969 private View findViewInsideOutShouldExist(View root, final int childViewId) {
5970 View result = root.findViewByPredicateInsideOut(this, new Predicate<View>() {
5971 @Override
5972 public boolean apply(View t) {
5973 return t.mID == childViewId;
5974 }
5975 });
5976
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005977 if (result == null) {
5978 Log.w(VIEW_LOG_TAG, "couldn't find next focus view specified "
5979 + "by user for id " + childViewId);
5980 }
5981 return result;
5982 }
5983
5984 /**
5985 * Find and return all focusable views that are descendants of this view,
5986 * possibly including this view if it is focusable itself.
5987 *
5988 * @param direction The direction of the focus
5989 * @return A list of focusable views
5990 */
5991 public ArrayList<View> getFocusables(int direction) {
5992 ArrayList<View> result = new ArrayList<View>(24);
5993 addFocusables(result, direction);
5994 return result;
5995 }
5996
5997 /**
5998 * Add any focusable views that are descendants of this view (possibly
5999 * including this view if it is focusable itself) to views. If we are in touch mode,
6000 * only add views that are also focusable in touch mode.
6001 *
6002 * @param views Focusable views found so far
6003 * @param direction The direction of the focus
6004 */
6005 public void addFocusables(ArrayList<View> views, int direction) {
svetoslavganov75986cf2009-05-14 22:28:01 -07006006 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE);
6007 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006008
svetoslavganov75986cf2009-05-14 22:28:01 -07006009 /**
6010 * Adds any focusable views that are descendants of this view (possibly
6011 * including this view if it is focusable itself) to views. This method
6012 * adds all focusable views regardless if we are in touch mode or
Svetoslav Ganov42138042012-03-20 11:51:39 -07006013 * only views focusable in touch mode if we are in touch mode or
6014 * only views that can take accessibility focus if accessibility is enabeld
6015 * depending on the focusable mode paramater.
svetoslavganov75986cf2009-05-14 22:28:01 -07006016 *
6017 * @param views Focusable views found so far or null if all we are interested is
6018 * the number of focusables.
6019 * @param direction The direction of the focus.
6020 * @param focusableMode The type of focusables to be added.
6021 *
6022 * @see #FOCUSABLES_ALL
6023 * @see #FOCUSABLES_TOUCH_MODE
6024 */
6025 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006026 if (views == null) {
svetoslavganov75986cf2009-05-14 22:28:01 -07006027 return;
6028 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006029 if ((focusableMode & FOCUSABLES_ACCESSIBILITY) == FOCUSABLES_ACCESSIBILITY) {
Svetoslav Ganov791fd312012-05-14 15:12:30 -07006030 if (canTakeAccessibilityFocusFromHover() || getAccessibilityNodeProvider() != null) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006031 views.add(this);
6032 return;
6033 }
6034 }
Svetoslav Ganov3cb889c2012-04-16 19:10:30 -07006035 if (!isFocusable()) {
6036 return;
svetoslavganov75986cf2009-05-14 22:28:01 -07006037 }
Svetoslav Ganov3cb889c2012-04-16 19:10:30 -07006038 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE
6039 && isInTouchMode() && !isFocusableInTouchMode()) {
6040 return;
6041 }
6042 views.add(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006043 }
6044
6045 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006046 * Finds the Views that contain given text. The containment is case insensitive.
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006047 * The search is performed by either the text that the View renders or the content
6048 * description that describes the view for accessibility purposes and the view does
6049 * not render or both. Clients can specify how the search is to be performed via
6050 * passing the {@link #FIND_VIEWS_WITH_TEXT} and
6051 * {@link #FIND_VIEWS_WITH_CONTENT_DESCRIPTION} flags.
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006052 *
6053 * @param outViews The output list of matching Views.
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006054 * @param searched The text to match against.
Svetoslav Ganov02107852011-10-03 17:06:56 -07006055 *
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006056 * @see #FIND_VIEWS_WITH_TEXT
6057 * @see #FIND_VIEWS_WITH_CONTENT_DESCRIPTION
6058 * @see #setContentDescription(CharSequence)
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006059 */
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006060 public void findViewsWithText(ArrayList<View> outViews, CharSequence searched, int flags) {
Svetoslav Ganov02107852011-10-03 17:06:56 -07006061 if (getAccessibilityNodeProvider() != null) {
6062 if ((flags & FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS) != 0) {
6063 outViews.add(this);
6064 }
6065 } else if ((flags & FIND_VIEWS_WITH_CONTENT_DESCRIPTION) != 0
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006066 && (searched != null && searched.length() > 0)
6067 && (mContentDescription != null && mContentDescription.length() > 0)) {
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006068 String searchedLowerCase = searched.toString().toLowerCase();
6069 String contentDescriptionLowerCase = mContentDescription.toString().toLowerCase();
6070 if (contentDescriptionLowerCase.contains(searchedLowerCase)) {
6071 outViews.add(this);
6072 }
6073 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006074 }
6075
6076 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006077 * Find and return all touchable views that are descendants of this view,
6078 * possibly including this view if it is touchable itself.
6079 *
6080 * @return A list of touchable views
6081 */
6082 public ArrayList<View> getTouchables() {
6083 ArrayList<View> result = new ArrayList<View>();
6084 addTouchables(result);
6085 return result;
6086 }
6087
6088 /**
6089 * Add any touchable views that are descendants of this view (possibly
6090 * including this view if it is touchable itself) to views.
6091 *
6092 * @param views Touchable views found so far
6093 */
6094 public void addTouchables(ArrayList<View> views) {
6095 final int viewFlags = mViewFlags;
6096
6097 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)
6098 && (viewFlags & ENABLED_MASK) == ENABLED) {
6099 views.add(this);
6100 }
6101 }
6102
6103 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -07006104 * Returns whether this View is accessibility focused.
6105 *
6106 * @return True if this View is accessibility focused.
6107 */
6108 boolean isAccessibilityFocused() {
6109 return (mPrivateFlags2 & ACCESSIBILITY_FOCUSED) != 0;
6110 }
6111
6112 /**
6113 * Call this to try to give accessibility focus to this view.
6114 *
6115 * A view will not actually take focus if {@link AccessibilityManager#isEnabled()}
6116 * returns false or the view is no visible or the view already has accessibility
6117 * focus.
6118 *
6119 * See also {@link #focusSearch(int)}, which is what you call to say that you
6120 * have focus, and you want your parent to look for the next one.
6121 *
6122 * @return Whether this view actually took accessibility focus.
6123 *
6124 * @hide
6125 */
6126 public boolean requestAccessibilityFocus() {
Svetoslav Ganov07b726c2012-04-30 12:24:57 -07006127 AccessibilityManager manager = AccessibilityManager.getInstance(mContext);
6128 if (!manager.isEnabled() || !manager.isTouchExplorationEnabled()) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006129 return false;
6130 }
6131 if ((mViewFlags & VISIBILITY_MASK) != VISIBLE) {
6132 return false;
6133 }
6134 if ((mPrivateFlags2 & ACCESSIBILITY_FOCUSED) == 0) {
6135 mPrivateFlags2 |= ACCESSIBILITY_FOCUSED;
6136 ViewRootImpl viewRootImpl = getViewRootImpl();
6137 if (viewRootImpl != null) {
6138 viewRootImpl.setAccessibilityFocusedHost(this);
6139 }
6140 invalidate();
6141 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED);
6142 notifyAccessibilityStateChanged();
6143 // Try to give input focus to this view - not a descendant.
6144 requestFocusNoSearch(View.FOCUS_DOWN, null);
6145 return true;
6146 }
6147 return false;
6148 }
6149
6150 /**
6151 * Call this to try to clear accessibility focus of this view.
6152 *
6153 * See also {@link #focusSearch(int)}, which is what you call to say that you
6154 * have focus, and you want your parent to look for the next one.
6155 *
6156 * @hide
6157 */
6158 public void clearAccessibilityFocus() {
Svetoslav Ganov791fd312012-05-14 15:12:30 -07006159 ViewRootImpl viewRootImpl = getViewRootImpl();
6160 if (viewRootImpl != null) {
6161 View focusHost = viewRootImpl.getAccessibilityFocusedHost();
Svetoslav Ganov64899e52012-05-15 21:09:30 -07006162 if (focusHost != null && focusHost != this
6163 && ViewRootImpl.isViewDescendantOf(focusHost, this)) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006164 viewRootImpl.setAccessibilityFocusedHost(null);
6165 }
Svetoslav Ganov791fd312012-05-14 15:12:30 -07006166 }
6167 if ((mPrivateFlags2 & ACCESSIBILITY_FOCUSED) != 0) {
6168 mPrivateFlags2 &= ~ACCESSIBILITY_FOCUSED;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006169 invalidate();
6170 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED);
6171 notifyAccessibilityStateChanged();
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006172
6173 // Clear the text navigation state.
6174 setAccessibilityCursorPosition(-1);
6175
Svetoslav Ganov42138042012-03-20 11:51:39 -07006176 // Try to move accessibility focus to the input focus.
6177 View rootView = getRootView();
6178 if (rootView != null) {
6179 View inputFocus = rootView.findFocus();
6180 if (inputFocus != null) {
6181 inputFocus.requestAccessibilityFocus();
6182 }
6183 }
6184 }
6185 }
6186
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07006187 private void requestAccessibilityFocusFromHover() {
6188 if (includeForAccessibility() && isActionableForAccessibility()) {
6189 requestAccessibilityFocus();
6190 } else {
6191 if (mParent != null) {
6192 View nextFocus = mParent.findViewToTakeAccessibilityFocusFromHover(this, this);
6193 if (nextFocus != null) {
6194 nextFocus.requestAccessibilityFocus();
6195 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006196 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006197 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006198 }
6199
6200 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -07006201 * @hide
6202 */
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07006203 public boolean canTakeAccessibilityFocusFromHover() {
6204 if (includeForAccessibility() && isActionableForAccessibility()) {
6205 return true;
6206 }
6207 if (mParent != null) {
6208 return (mParent.findViewToTakeAccessibilityFocusFromHover(this, this) == this);
Svetoslav Ganov42138042012-03-20 11:51:39 -07006209 }
6210 return false;
6211 }
6212
6213 /**
6214 * Clears accessibility focus without calling any callback methods
6215 * normally invoked in {@link #clearAccessibilityFocus()}. This method
6216 * is used for clearing accessibility focus when giving this focus to
6217 * another view.
6218 */
6219 void clearAccessibilityFocusNoCallbacks() {
6220 if ((mPrivateFlags2 & ACCESSIBILITY_FOCUSED) != 0) {
6221 mPrivateFlags2 &= ~ACCESSIBILITY_FOCUSED;
6222 invalidate();
6223 }
6224 }
6225
6226 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006227 * Call this to try to give focus to a specific view or to one of its
6228 * descendants.
6229 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006230 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
6231 * false), or if it is focusable and it is not focusable in touch mode
6232 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006233 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07006234 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006235 * have focus, and you want your parent to look for the next one.
6236 *
6237 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments
6238 * {@link #FOCUS_DOWN} and <code>null</code>.
6239 *
6240 * @return Whether this view or one of its descendants actually took focus.
6241 */
6242 public final boolean requestFocus() {
6243 return requestFocus(View.FOCUS_DOWN);
6244 }
6245
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006246 /**
6247 * Call this to try to give focus to a specific view or to one of its
6248 * descendants and give it a hint about what direction focus is heading.
6249 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006250 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
6251 * false), or if it is focusable and it is not focusable in touch mode
6252 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006253 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07006254 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006255 * have focus, and you want your parent to look for the next one.
6256 *
6257 * This is equivalent to calling {@link #requestFocus(int, Rect)} with
6258 * <code>null</code> set for the previously focused rectangle.
6259 *
6260 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
6261 * @return Whether this view or one of its descendants actually took focus.
6262 */
6263 public final boolean requestFocus(int direction) {
6264 return requestFocus(direction, null);
6265 }
6266
6267 /**
6268 * Call this to try to give focus to a specific view or to one of its descendants
6269 * and give it hints about the direction and a specific rectangle that the focus
6270 * is coming from. The rectangle can help give larger views a finer grained hint
6271 * about where focus is coming from, and therefore, where to show selection, or
6272 * forward focus change internally.
6273 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006274 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
6275 * false), or if it is focusable and it is not focusable in touch mode
6276 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006277 *
6278 * A View will not take focus if it is not visible.
6279 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006280 * A View will not take focus if one of its parents has
6281 * {@link android.view.ViewGroup#getDescendantFocusability()} equal to
6282 * {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006283 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07006284 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006285 * have focus, and you want your parent to look for the next one.
6286 *
6287 * You may wish to override this method if your custom {@link View} has an internal
6288 * {@link View} that it wishes to forward the request to.
6289 *
6290 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
6291 * @param previouslyFocusedRect The rectangle (in this View's coordinate system)
6292 * to give a finer grained hint about where focus is coming from. May be null
6293 * if there is no hint.
6294 * @return Whether this view or one of its descendants actually took focus.
6295 */
6296 public boolean requestFocus(int direction, Rect previouslyFocusedRect) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006297 return requestFocusNoSearch(direction, previouslyFocusedRect);
6298 }
6299
6300 private boolean requestFocusNoSearch(int direction, Rect previouslyFocusedRect) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006301 // need to be focusable
6302 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE ||
6303 (mViewFlags & VISIBILITY_MASK) != VISIBLE) {
6304 return false;
6305 }
6306
6307 // need to be focusable in touch mode if in touch mode
6308 if (isInTouchMode() &&
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006309 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) {
6310 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006311 }
6312
6313 // need to not have any parents blocking us
6314 if (hasAncestorThatBlocksDescendantFocus()) {
6315 return false;
6316 }
6317
6318 handleFocusGainInternal(direction, previouslyFocusedRect);
6319 return true;
6320 }
6321
6322 /**
6323 * Call this to try to give focus to a specific view or to one of its descendants. This is a
6324 * special variant of {@link #requestFocus() } that will allow views that are not focuable in
6325 * touch mode to request focus when they are touched.
6326 *
6327 * @return Whether this view or one of its descendants actually took focus.
6328 *
6329 * @see #isInTouchMode()
6330 *
6331 */
6332 public final boolean requestFocusFromTouch() {
6333 // Leave touch mode if we need to
6334 if (isInTouchMode()) {
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07006335 ViewRootImpl viewRoot = getViewRootImpl();
Christopher Tate2c095f32010-10-04 14:13:40 -07006336 if (viewRoot != null) {
6337 viewRoot.ensureTouchMode(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006338 }
6339 }
6340 return requestFocus(View.FOCUS_DOWN);
6341 }
6342
6343 /**
6344 * @return Whether any ancestor of this view blocks descendant focus.
6345 */
6346 private boolean hasAncestorThatBlocksDescendantFocus() {
6347 ViewParent ancestor = mParent;
6348 while (ancestor instanceof ViewGroup) {
6349 final ViewGroup vgAncestor = (ViewGroup) ancestor;
6350 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) {
6351 return true;
6352 } else {
6353 ancestor = vgAncestor.getParent();
6354 }
6355 }
6356 return false;
6357 }
6358
6359 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -07006360 * Gets the mode for determining whether this View is important for accessibility
6361 * which is if it fires accessibility events and if it is reported to
6362 * accessibility services that query the screen.
6363 *
6364 * @return The mode for determining whether a View is important for accessibility.
6365 *
6366 * @attr ref android.R.styleable#View_importantForAccessibility
6367 *
6368 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES
6369 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO
6370 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO
6371 */
6372 @ViewDebug.ExportedProperty(category = "accessibility", mapping = {
6373 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_AUTO,
6374 to = "IMPORTANT_FOR_ACCESSIBILITY_AUTO"),
6375 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_YES,
6376 to = "IMPORTANT_FOR_ACCESSIBILITY_YES"),
6377 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_NO,
6378 to = "IMPORTANT_FOR_ACCESSIBILITY_NO")
6379 })
6380 public int getImportantForAccessibility() {
6381 return (mPrivateFlags2 & IMPORTANT_FOR_ACCESSIBILITY_MASK)
6382 >> IMPORTANT_FOR_ACCESSIBILITY_SHIFT;
6383 }
6384
6385 /**
6386 * Sets how to determine whether this view is important for accessibility
6387 * which is if it fires accessibility events and if it is reported to
6388 * accessibility services that query the screen.
6389 *
6390 * @param mode How to determine whether this view is important for accessibility.
6391 *
6392 * @attr ref android.R.styleable#View_importantForAccessibility
6393 *
6394 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES
6395 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO
6396 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO
6397 */
6398 public void setImportantForAccessibility(int mode) {
6399 if (mode != getImportantForAccessibility()) {
6400 mPrivateFlags2 &= ~IMPORTANT_FOR_ACCESSIBILITY_MASK;
6401 mPrivateFlags2 |= (mode << IMPORTANT_FOR_ACCESSIBILITY_SHIFT)
6402 & IMPORTANT_FOR_ACCESSIBILITY_MASK;
6403 notifyAccessibilityStateChanged();
6404 }
6405 }
6406
6407 /**
6408 * Gets whether this view should be exposed for accessibility.
6409 *
6410 * @return Whether the view is exposed for accessibility.
6411 *
6412 * @hide
6413 */
6414 public boolean isImportantForAccessibility() {
6415 final int mode = (mPrivateFlags2 & IMPORTANT_FOR_ACCESSIBILITY_MASK)
6416 >> IMPORTANT_FOR_ACCESSIBILITY_SHIFT;
6417 switch (mode) {
6418 case IMPORTANT_FOR_ACCESSIBILITY_YES:
6419 return true;
6420 case IMPORTANT_FOR_ACCESSIBILITY_NO:
6421 return false;
6422 case IMPORTANT_FOR_ACCESSIBILITY_AUTO:
6423 return isActionableForAccessibility() || hasListenersForAccessibility();
6424 default:
6425 throw new IllegalArgumentException("Unknow important for accessibility mode: "
6426 + mode);
6427 }
6428 }
6429
6430 /**
6431 * Gets the parent for accessibility purposes. Note that the parent for
6432 * accessibility is not necessary the immediate parent. It is the first
6433 * predecessor that is important for accessibility.
6434 *
6435 * @return The parent for accessibility purposes.
6436 */
6437 public ViewParent getParentForAccessibility() {
6438 if (mParent instanceof View) {
6439 View parentView = (View) mParent;
6440 if (parentView.includeForAccessibility()) {
6441 return mParent;
6442 } else {
6443 return mParent.getParentForAccessibility();
6444 }
6445 }
6446 return null;
6447 }
6448
6449 /**
6450 * Adds the children of a given View for accessibility. Since some Views are
6451 * not important for accessibility the children for accessibility are not
6452 * necessarily direct children of the riew, rather they are the first level of
6453 * descendants important for accessibility.
6454 *
6455 * @param children The list of children for accessibility.
6456 */
6457 public void addChildrenForAccessibility(ArrayList<View> children) {
6458 if (includeForAccessibility()) {
6459 children.add(this);
6460 }
6461 }
6462
6463 /**
6464 * Whether to regard this view for accessibility. A view is regarded for
6465 * accessibility if it is important for accessibility or the querying
6466 * accessibility service has explicitly requested that view not
6467 * important for accessibility are regarded.
6468 *
6469 * @return Whether to regard the view for accessibility.
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07006470 *
6471 * @hide
Svetoslav Ganov42138042012-03-20 11:51:39 -07006472 */
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07006473 public boolean includeForAccessibility() {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006474 if (mAttachInfo != null) {
6475 if (!mAttachInfo.mIncludeNotImportantViews) {
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07006476 return isImportantForAccessibility();
Svetoslav Ganov42138042012-03-20 11:51:39 -07006477 }
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07006478 return true;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006479 }
6480 return false;
6481 }
6482
6483 /**
6484 * Returns whether the View is considered actionable from
6485 * accessibility perspective. Such view are important for
6486 * accessiiblity.
6487 *
6488 * @return True if the view is actionable for accessibility.
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07006489 *
6490 * @hide
Svetoslav Ganov42138042012-03-20 11:51:39 -07006491 */
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07006492 public boolean isActionableForAccessibility() {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006493 return (isClickable() || isLongClickable() || isFocusable());
6494 }
6495
6496 /**
6497 * Returns whether the View has registered callbacks wich makes it
6498 * important for accessiiblity.
6499 *
6500 * @return True if the view is actionable for accessibility.
6501 */
6502 private boolean hasListenersForAccessibility() {
6503 ListenerInfo info = getListenerInfo();
6504 return mTouchDelegate != null || info.mOnKeyListener != null
6505 || info.mOnTouchListener != null || info.mOnGenericMotionListener != null
6506 || info.mOnHoverListener != null || info.mOnDragListener != null;
6507 }
6508
6509 /**
6510 * Notifies accessibility services that some view's important for
6511 * accessibility state has changed. Note that such notifications
6512 * are made at most once every
6513 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}
6514 * to avoid unnecessary load to the system. Also once a view has
6515 * made a notifucation this method is a NOP until the notification has
6516 * been sent to clients.
6517 *
6518 * @hide
6519 *
6520 * TODO: Makse sure this method is called for any view state change
6521 * that is interesting for accessilility purposes.
6522 */
6523 public void notifyAccessibilityStateChanged() {
Svetoslav Ganovc406be92012-05-11 16:12:32 -07006524 if (!AccessibilityManager.getInstance(mContext).isEnabled()) {
6525 return;
6526 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006527 if ((mPrivateFlags2 & ACCESSIBILITY_STATE_CHANGED) == 0) {
6528 mPrivateFlags2 |= ACCESSIBILITY_STATE_CHANGED;
6529 if (mParent != null) {
6530 mParent.childAccessibilityStateChanged(this);
6531 }
6532 }
6533 }
6534
6535 /**
6536 * Reset the state indicating the this view has requested clients
6537 * interested in its accessiblity state to be notified.
6538 *
6539 * @hide
6540 */
6541 public void resetAccessibilityStateChanged() {
6542 mPrivateFlags2 &= ~ACCESSIBILITY_STATE_CHANGED;
6543 }
6544
6545 /**
6546 * Performs the specified accessibility action on the view. For
6547 * possible accessibility actions look at {@link AccessibilityNodeInfo}.
alanv8eeefef2012-05-07 16:57:53 -07006548 * <p>
6549 * If an {@link AccessibilityDelegate} has been specified via calling
6550 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
6551 * {@link AccessibilityDelegate#performAccessibilityAction(View, int, Bundle)}
6552 * is responsible for handling this call.
6553 * </p>
Svetoslav Ganov42138042012-03-20 11:51:39 -07006554 *
6555 * @param action The action to perform.
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006556 * @param arguments Optional action arguments.
Svetoslav Ganov42138042012-03-20 11:51:39 -07006557 * @return Whether the action was performed.
6558 */
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006559 public boolean performAccessibilityAction(int action, Bundle arguments) {
alanv8eeefef2012-05-07 16:57:53 -07006560 if (mAccessibilityDelegate != null) {
6561 return mAccessibilityDelegate.performAccessibilityAction(this, action, arguments);
6562 } else {
6563 return performAccessibilityActionInternal(action, arguments);
6564 }
6565 }
6566
6567 /**
6568 * @see #performAccessibilityAction(int, Bundle)
6569 *
6570 * Note: Called from the default {@link AccessibilityDelegate}.
6571 */
6572 boolean performAccessibilityActionInternal(int action, Bundle arguments) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006573 switch (action) {
6574 case AccessibilityNodeInfo.ACTION_CLICK: {
Svetoslav Ganov005b83b2012-04-16 18:17:17 -07006575 if (isClickable()) {
Svetoslav Ganov773f2622012-05-05 19:59:42 -07006576 return performClick();
Svetoslav Ganov005b83b2012-04-16 18:17:17 -07006577 }
6578 } break;
6579 case AccessibilityNodeInfo.ACTION_LONG_CLICK: {
6580 if (isLongClickable()) {
Svetoslav Ganov773f2622012-05-05 19:59:42 -07006581 return performLongClick();
Svetoslav Ganov005b83b2012-04-16 18:17:17 -07006582 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006583 } break;
6584 case AccessibilityNodeInfo.ACTION_FOCUS: {
6585 if (!hasFocus()) {
6586 // Get out of touch mode since accessibility
6587 // wants to move focus around.
6588 getViewRootImpl().ensureTouchMode(false);
6589 return requestFocus();
6590 }
6591 } break;
6592 case AccessibilityNodeInfo.ACTION_CLEAR_FOCUS: {
6593 if (hasFocus()) {
6594 clearFocus();
6595 return !isFocused();
6596 }
6597 } break;
6598 case AccessibilityNodeInfo.ACTION_SELECT: {
6599 if (!isSelected()) {
6600 setSelected(true);
6601 return isSelected();
6602 }
6603 } break;
6604 case AccessibilityNodeInfo.ACTION_CLEAR_SELECTION: {
6605 if (isSelected()) {
6606 setSelected(false);
6607 return !isSelected();
6608 }
6609 } break;
6610 case AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS: {
6611 if (!isAccessibilityFocused()) {
6612 return requestAccessibilityFocus();
6613 }
6614 } break;
6615 case AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS: {
6616 if (isAccessibilityFocused()) {
6617 clearAccessibilityFocus();
6618 return true;
6619 }
6620 } break;
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006621 case AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY: {
6622 if (arguments != null) {
6623 final int granularity = arguments.getInt(
6624 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT);
6625 return nextAtGranularity(granularity);
6626 }
6627 } break;
6628 case AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY: {
6629 if (arguments != null) {
6630 final int granularity = arguments.getInt(
6631 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT);
6632 return previousAtGranularity(granularity);
6633 }
6634 } break;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006635 }
6636 return false;
6637 }
6638
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006639 private boolean nextAtGranularity(int granularity) {
6640 CharSequence text = getIterableTextForAccessibility();
Svetoslav Ganov64899e52012-05-15 21:09:30 -07006641 if (text == null || text.length() == 0) {
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006642 return false;
6643 }
6644 TextSegmentIterator iterator = getIteratorForGranularity(granularity);
6645 if (iterator == null) {
6646 return false;
6647 }
6648 final int current = getAccessibilityCursorPosition();
6649 final int[] range = iterator.following(current);
6650 if (range == null) {
6651 setAccessibilityCursorPosition(-1);
6652 return false;
6653 }
6654 final int start = range[0];
6655 final int end = range[1];
6656 setAccessibilityCursorPosition(start);
6657 sendViewTextTraversedAtGranularityEvent(
6658 AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY,
6659 granularity, start, end);
6660 return true;
6661 }
6662
6663 private boolean previousAtGranularity(int granularity) {
6664 CharSequence text = getIterableTextForAccessibility();
Svetoslav Ganov64899e52012-05-15 21:09:30 -07006665 if (text == null || text.length() == 0) {
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006666 return false;
6667 }
6668 TextSegmentIterator iterator = getIteratorForGranularity(granularity);
6669 if (iterator == null) {
6670 return false;
6671 }
6672 final int selectionStart = getAccessibilityCursorPosition();
6673 final int current = selectionStart >= 0 ? selectionStart : text.length() + 1;
6674 final int[] range = iterator.preceding(current);
6675 if (range == null) {
6676 setAccessibilityCursorPosition(-1);
6677 return false;
6678 }
6679 final int start = range[0];
6680 final int end = range[1];
6681 setAccessibilityCursorPosition(end);
6682 sendViewTextTraversedAtGranularityEvent(
6683 AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY,
6684 granularity, start, end);
6685 return true;
6686 }
6687
6688 /**
6689 * Gets the text reported for accessibility purposes.
6690 *
6691 * @return The accessibility text.
6692 *
6693 * @hide
6694 */
6695 public CharSequence getIterableTextForAccessibility() {
6696 return mContentDescription;
6697 }
6698
6699 /**
6700 * @hide
6701 */
6702 public int getAccessibilityCursorPosition() {
6703 return mAccessibilityCursorPosition;
6704 }
6705
6706 /**
6707 * @hide
6708 */
6709 public void setAccessibilityCursorPosition(int position) {
6710 mAccessibilityCursorPosition = position;
6711 }
6712
6713 private void sendViewTextTraversedAtGranularityEvent(int action, int granularity,
6714 int fromIndex, int toIndex) {
6715 if (mParent == null) {
6716 return;
6717 }
6718 AccessibilityEvent event = AccessibilityEvent.obtain(
6719 AccessibilityEvent.TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY);
6720 onInitializeAccessibilityEvent(event);
6721 onPopulateAccessibilityEvent(event);
6722 event.setFromIndex(fromIndex);
6723 event.setToIndex(toIndex);
6724 event.setAction(action);
6725 event.setMovementGranularity(granularity);
6726 mParent.requestSendAccessibilityEvent(this, event);
6727 }
6728
6729 /**
6730 * @hide
6731 */
6732 public TextSegmentIterator getIteratorForGranularity(int granularity) {
6733 switch (granularity) {
6734 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER: {
6735 CharSequence text = getIterableTextForAccessibility();
6736 if (text != null && text.length() > 0) {
6737 CharacterTextSegmentIterator iterator =
6738 CharacterTextSegmentIterator.getInstance(mContext);
6739 iterator.initialize(text.toString());
6740 return iterator;
6741 }
6742 } break;
6743 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD: {
6744 CharSequence text = getIterableTextForAccessibility();
6745 if (text != null && text.length() > 0) {
6746 WordTextSegmentIterator iterator =
6747 WordTextSegmentIterator.getInstance(mContext);
6748 iterator.initialize(text.toString());
6749 return iterator;
6750 }
6751 } break;
6752 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH: {
6753 CharSequence text = getIterableTextForAccessibility();
6754 if (text != null && text.length() > 0) {
6755 ParagraphTextSegmentIterator iterator =
6756 ParagraphTextSegmentIterator.getInstance();
6757 iterator.initialize(text.toString());
6758 return iterator;
6759 }
6760 } break;
6761 }
6762 return null;
6763 }
6764
Svetoslav Ganov42138042012-03-20 11:51:39 -07006765 /**
Romain Guya440b002010-02-24 15:57:54 -08006766 * @hide
6767 */
6768 public void dispatchStartTemporaryDetach() {
Svetoslav Ganov961bf0e2012-05-08 09:40:03 -07006769 clearAccessibilityFocus();
Romain Guya440b002010-02-24 15:57:54 -08006770 onStartTemporaryDetach();
6771 }
6772
6773 /**
6774 * This is called when a container is going to temporarily detach a child, with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006775 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}.
6776 * It will either be followed by {@link #onFinishTemporaryDetach()} or
Romain Guya440b002010-02-24 15:57:54 -08006777 * {@link #onDetachedFromWindow()} when the container is done.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006778 */
6779 public void onStartTemporaryDetach() {
Romain Guya440b002010-02-24 15:57:54 -08006780 removeUnsetPressCallback();
Romain Guy8afa5152010-02-26 11:56:30 -08006781 mPrivateFlags |= CANCEL_NEXT_UP_EVENT;
Romain Guya440b002010-02-24 15:57:54 -08006782 }
6783
6784 /**
6785 * @hide
6786 */
6787 public void dispatchFinishTemporaryDetach() {
6788 onFinishTemporaryDetach();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006789 }
Romain Guy8506ab42009-06-11 17:35:47 -07006790
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006791 /**
6792 * Called after {@link #onStartTemporaryDetach} when the container is done
6793 * changing the view.
6794 */
6795 public void onFinishTemporaryDetach() {
6796 }
Romain Guy8506ab42009-06-11 17:35:47 -07006797
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006798 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07006799 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState}
6800 * for this view's window. Returns null if the view is not currently attached
6801 * to the window. Normally you will not need to use this directly, but
Romain Guy5c22a8c2011-05-13 11:48:45 -07006802 * just use the standard high-level event callbacks like
6803 * {@link #onKeyDown(int, KeyEvent)}.
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07006804 */
6805 public KeyEvent.DispatcherState getKeyDispatcherState() {
6806 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null;
6807 }
Joe Malin32736f02011-01-19 16:14:20 -08006808
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07006809 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006810 * Dispatch a key event before it is processed by any input method
6811 * associated with the view hierarchy. This can be used to intercept
6812 * key events in special situations before the IME consumes them; a
6813 * typical example would be handling the BACK key to update the application's
6814 * UI instead of allowing the IME to see it and close itself.
6815 *
6816 * @param event The key event to be dispatched.
6817 * @return True if the event was handled, false otherwise.
6818 */
6819 public boolean dispatchKeyEventPreIme(KeyEvent event) {
6820 return onKeyPreIme(event.getKeyCode(), event);
6821 }
6822
6823 /**
6824 * Dispatch a key event to the next view on the focus path. This path runs
6825 * from the top of the view tree down to the currently focused view. If this
6826 * view has focus, it will dispatch to itself. Otherwise it will dispatch
6827 * the next node down the focus path. This method also fires any key
6828 * listeners.
6829 *
6830 * @param event The key event to be dispatched.
6831 * @return True if the event was handled, false otherwise.
6832 */
6833 public boolean dispatchKeyEvent(KeyEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08006834 if (mInputEventConsistencyVerifier != null) {
6835 mInputEventConsistencyVerifier.onKeyEvent(event, 0);
6836 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006837
Jeff Brown21bc5c92011-02-28 18:27:14 -08006838 // Give any attached key listener a first crack at the event.
Romain Guyf607bdc2010-09-10 19:20:06 -07006839 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07006840 ListenerInfo li = mListenerInfo;
6841 if (li != null && li.mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
6842 && li.mOnKeyListener.onKey(this, event.getKeyCode(), event)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006843 return true;
6844 }
6845
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006846 if (event.dispatch(this, mAttachInfo != null
6847 ? mAttachInfo.mKeyDispatchState : null, this)) {
6848 return true;
6849 }
6850
6851 if (mInputEventConsistencyVerifier != null) {
6852 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
6853 }
6854 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006855 }
6856
6857 /**
6858 * Dispatches a key shortcut event.
6859 *
6860 * @param event The key event to be dispatched.
6861 * @return True if the event was handled by the view, false otherwise.
6862 */
6863 public boolean dispatchKeyShortcutEvent(KeyEvent event) {
6864 return onKeyShortcut(event.getKeyCode(), event);
6865 }
6866
6867 /**
6868 * Pass the touch screen motion event down to the target view, or this
6869 * view if it is the target.
6870 *
6871 * @param event The motion event to be dispatched.
6872 * @return True if the event was handled by the view, false otherwise.
6873 */
6874 public boolean dispatchTouchEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08006875 if (mInputEventConsistencyVerifier != null) {
6876 mInputEventConsistencyVerifier.onTouchEvent(event, 0);
6877 }
6878
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006879 if (onFilterTouchEventForSecurity(event)) {
6880 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07006881 ListenerInfo li = mListenerInfo;
6882 if (li != null && li.mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
6883 && li.mOnTouchListener.onTouch(this, event)) {
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006884 return true;
6885 }
6886
6887 if (onTouchEvent(event)) {
6888 return true;
6889 }
Jeff Brown85a31762010-09-01 17:01:00 -07006890 }
6891
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006892 if (mInputEventConsistencyVerifier != null) {
6893 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006894 }
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006895 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006896 }
6897
6898 /**
Jeff Brown85a31762010-09-01 17:01:00 -07006899 * Filter the touch event to apply security policies.
6900 *
6901 * @param event The motion event to be filtered.
6902 * @return True if the event should be dispatched, false if the event should be dropped.
Joe Malin32736f02011-01-19 16:14:20 -08006903 *
Jeff Brown85a31762010-09-01 17:01:00 -07006904 * @see #getFilterTouchesWhenObscured
6905 */
6906 public boolean onFilterTouchEventForSecurity(MotionEvent event) {
Romain Guyf607bdc2010-09-10 19:20:06 -07006907 //noinspection RedundantIfStatement
Jeff Brown85a31762010-09-01 17:01:00 -07006908 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0
6909 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) {
6910 // Window is obscured, drop this touch.
6911 return false;
6912 }
6913 return true;
6914 }
6915
6916 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006917 * Pass a trackball motion event down to the focused view.
6918 *
6919 * @param event The motion event to be dispatched.
6920 * @return True if the event was handled by the view, false otherwise.
6921 */
6922 public boolean dispatchTrackballEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08006923 if (mInputEventConsistencyVerifier != null) {
6924 mInputEventConsistencyVerifier.onTrackballEvent(event, 0);
6925 }
6926
Romain Guy02ccac62011-06-24 13:20:23 -07006927 return onTrackballEvent(event);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006928 }
6929
6930 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08006931 * Dispatch a generic motion event.
6932 * <p>
6933 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER}
6934 * are delivered to the view under the pointer. All other generic motion events are
Jeff Browna032cc02011-03-07 16:56:21 -08006935 * delivered to the focused view. Hover events are handled specially and are delivered
Romain Guy5c22a8c2011-05-13 11:48:45 -07006936 * to {@link #onHoverEvent(MotionEvent)}.
Jeff Brown33bbfd22011-02-24 20:55:35 -08006937 * </p>
Jeff Browncb1404e2011-01-15 18:14:15 -08006938 *
6939 * @param event The motion event to be dispatched.
6940 * @return True if the event was handled by the view, false otherwise.
6941 */
6942 public boolean dispatchGenericMotionEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08006943 if (mInputEventConsistencyVerifier != null) {
6944 mInputEventConsistencyVerifier.onGenericMotionEvent(event, 0);
6945 }
6946
Jeff Browna032cc02011-03-07 16:56:21 -08006947 final int source = event.getSource();
6948 if ((source & InputDevice.SOURCE_CLASS_POINTER) != 0) {
6949 final int action = event.getAction();
6950 if (action == MotionEvent.ACTION_HOVER_ENTER
6951 || action == MotionEvent.ACTION_HOVER_MOVE
6952 || action == MotionEvent.ACTION_HOVER_EXIT) {
6953 if (dispatchHoverEvent(event)) {
6954 return true;
6955 }
6956 } else if (dispatchGenericPointerEvent(event)) {
6957 return true;
6958 }
6959 } else if (dispatchGenericFocusedEvent(event)) {
6960 return true;
6961 }
6962
Jeff Brown10b62902011-06-20 16:40:37 -07006963 if (dispatchGenericMotionEventInternal(event)) {
6964 return true;
6965 }
6966
6967 if (mInputEventConsistencyVerifier != null) {
6968 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
6969 }
6970 return false;
6971 }
6972
6973 private boolean dispatchGenericMotionEventInternal(MotionEvent event) {
Romain Guy7b5b6ab2011-03-14 18:05:08 -07006974 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07006975 ListenerInfo li = mListenerInfo;
6976 if (li != null && li.mOnGenericMotionListener != null
6977 && (mViewFlags & ENABLED_MASK) == ENABLED
6978 && li.mOnGenericMotionListener.onGenericMotion(this, event)) {
Jeff Brown33bbfd22011-02-24 20:55:35 -08006979 return true;
6980 }
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006981
6982 if (onGenericMotionEvent(event)) {
6983 return true;
6984 }
6985
6986 if (mInputEventConsistencyVerifier != null) {
6987 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
6988 }
6989 return false;
Jeff Browncb1404e2011-01-15 18:14:15 -08006990 }
6991
6992 /**
Jeff Browna032cc02011-03-07 16:56:21 -08006993 * Dispatch a hover event.
6994 * <p>
Philip Milne6c8ea062012-04-03 17:38:43 -07006995 * Do not call this method directly.
Romain Guy5c22a8c2011-05-13 11:48:45 -07006996 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08006997 * </p>
6998 *
6999 * @param event The motion event to be dispatched.
7000 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08007001 */
7002 protected boolean dispatchHoverEvent(MotionEvent event) {
Romain Guy02ccac62011-06-24 13:20:23 -07007003 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07007004 ListenerInfo li = mListenerInfo;
7005 if (li != null && li.mOnHoverListener != null
7006 && (mViewFlags & ENABLED_MASK) == ENABLED
7007 && li.mOnHoverListener.onHover(this, event)) {
Jeff Brown10b62902011-06-20 16:40:37 -07007008 return true;
7009 }
7010
Jeff Browna032cc02011-03-07 16:56:21 -08007011 return onHoverEvent(event);
7012 }
7013
7014 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07007015 * Returns true if the view has a child to which it has recently sent
7016 * {@link MotionEvent#ACTION_HOVER_ENTER}. If this view is hovered and
7017 * it does not have a hovered child, then it must be the innermost hovered view.
7018 * @hide
7019 */
7020 protected boolean hasHoveredChild() {
7021 return false;
7022 }
7023
7024 /**
Jeff Browna032cc02011-03-07 16:56:21 -08007025 * Dispatch a generic motion event to the view under the first pointer.
7026 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07007027 * Do not call this method directly.
7028 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08007029 * </p>
7030 *
7031 * @param event The motion event to be dispatched.
7032 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08007033 */
7034 protected boolean dispatchGenericPointerEvent(MotionEvent event) {
7035 return false;
7036 }
7037
7038 /**
7039 * Dispatch a generic motion event to the currently focused view.
7040 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07007041 * Do not call this method directly.
7042 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08007043 * </p>
7044 *
7045 * @param event The motion event to be dispatched.
7046 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08007047 */
7048 protected boolean dispatchGenericFocusedEvent(MotionEvent event) {
7049 return false;
7050 }
7051
7052 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08007053 * Dispatch a pointer event.
7054 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07007055 * Dispatches touch related pointer events to {@link #onTouchEvent(MotionEvent)} and all
7056 * other events to {@link #onGenericMotionEvent(MotionEvent)}. This separation of concerns
7057 * reinforces the invariant that {@link #onTouchEvent(MotionEvent)} is really about touches
Jeff Brown33bbfd22011-02-24 20:55:35 -08007058 * and should not be expected to handle other pointing device features.
7059 * </p>
7060 *
7061 * @param event The motion event to be dispatched.
7062 * @return True if the event was handled by the view, false otherwise.
7063 * @hide
7064 */
7065 public final boolean dispatchPointerEvent(MotionEvent event) {
7066 if (event.isTouchEvent()) {
7067 return dispatchTouchEvent(event);
7068 } else {
7069 return dispatchGenericMotionEvent(event);
7070 }
7071 }
7072
7073 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007074 * Called when the window containing this view gains or loses window focus.
7075 * ViewGroups should override to route to their children.
7076 *
7077 * @param hasFocus True if the window containing this view now has focus,
7078 * false otherwise.
7079 */
7080 public void dispatchWindowFocusChanged(boolean hasFocus) {
7081 onWindowFocusChanged(hasFocus);
7082 }
7083
7084 /**
7085 * Called when the window containing this view gains or loses focus. Note
7086 * that this is separate from view focus: to receive key events, both
7087 * your view and its window must have focus. If a window is displayed
7088 * on top of yours that takes input focus, then your own window will lose
7089 * focus but the view focus will remain unchanged.
7090 *
7091 * @param hasWindowFocus True if the window containing this view now has
7092 * focus, false otherwise.
7093 */
7094 public void onWindowFocusChanged(boolean hasWindowFocus) {
7095 InputMethodManager imm = InputMethodManager.peekInstance();
7096 if (!hasWindowFocus) {
7097 if (isPressed()) {
7098 setPressed(false);
7099 }
7100 if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
7101 imm.focusOut(this);
7102 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05007103 removeLongPressCallback();
Tony Wu26edf202010-09-13 19:54:00 +08007104 removeTapCallback();
Romain Guya2431d02009-04-30 16:30:00 -07007105 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007106 } else if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
7107 imm.focusIn(this);
7108 }
7109 refreshDrawableState();
7110 }
7111
7112 /**
7113 * Returns true if this view is in a window that currently has window focus.
7114 * Note that this is not the same as the view itself having focus.
7115 *
7116 * @return True if this view is in a window that currently has window focus.
7117 */
7118 public boolean hasWindowFocus() {
7119 return mAttachInfo != null && mAttachInfo.mHasWindowFocus;
7120 }
7121
7122 /**
Adam Powell326d8082009-12-09 15:10:07 -08007123 * Dispatch a view visibility change down the view hierarchy.
7124 * ViewGroups should override to route to their children.
7125 * @param changedView The view whose visibility changed. Could be 'this' or
7126 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08007127 * @param visibility The new visibility of changedView: {@link #VISIBLE},
7128 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08007129 */
7130 protected void dispatchVisibilityChanged(View changedView, int visibility) {
7131 onVisibilityChanged(changedView, visibility);
7132 }
7133
7134 /**
7135 * Called when the visibility of the view or an ancestor of the view is changed.
7136 * @param changedView The view whose visibility changed. Could be 'this' or
7137 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08007138 * @param visibility The new visibility of changedView: {@link #VISIBLE},
7139 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08007140 */
7141 protected void onVisibilityChanged(View changedView, int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07007142 if (visibility == VISIBLE) {
7143 if (mAttachInfo != null) {
7144 initialAwakenScrollBars();
7145 } else {
7146 mPrivateFlags |= AWAKEN_SCROLL_BARS_ON_ATTACH;
7147 }
7148 }
Adam Powell326d8082009-12-09 15:10:07 -08007149 }
7150
7151 /**
Romain Guy43c9cdf2010-01-27 13:53:55 -08007152 * Dispatch a hint about whether this view is displayed. For instance, when
7153 * a View moves out of the screen, it might receives a display hint indicating
7154 * the view is not displayed. Applications should not <em>rely</em> on this hint
7155 * as there is no guarantee that they will receive one.
Joe Malin32736f02011-01-19 16:14:20 -08007156 *
Romain Guy43c9cdf2010-01-27 13:53:55 -08007157 * @param hint A hint about whether or not this view is displayed:
7158 * {@link #VISIBLE} or {@link #INVISIBLE}.
7159 */
7160 public void dispatchDisplayHint(int hint) {
7161 onDisplayHint(hint);
7162 }
7163
7164 /**
7165 * Gives this view a hint about whether is displayed or not. For instance, when
7166 * a View moves out of the screen, it might receives a display hint indicating
7167 * the view is not displayed. Applications should not <em>rely</em> on this hint
7168 * as there is no guarantee that they will receive one.
Joe Malin32736f02011-01-19 16:14:20 -08007169 *
Romain Guy43c9cdf2010-01-27 13:53:55 -08007170 * @param hint A hint about whether or not this view is displayed:
7171 * {@link #VISIBLE} or {@link #INVISIBLE}.
7172 */
7173 protected void onDisplayHint(int hint) {
7174 }
7175
7176 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007177 * Dispatch a window visibility change down the view hierarchy.
7178 * ViewGroups should override to route to their children.
7179 *
7180 * @param visibility The new visibility of the window.
7181 *
Philip Milne6c8ea062012-04-03 17:38:43 -07007182 * @see #onWindowVisibilityChanged(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007183 */
7184 public void dispatchWindowVisibilityChanged(int visibility) {
7185 onWindowVisibilityChanged(visibility);
7186 }
7187
7188 /**
7189 * Called when the window containing has change its visibility
7190 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note
7191 * that this tells you whether or not your window is being made visible
7192 * to the window manager; this does <em>not</em> tell you whether or not
7193 * your window is obscured by other windows on the screen, even if it
7194 * is itself visible.
7195 *
7196 * @param visibility The new visibility of the window.
7197 */
7198 protected void onWindowVisibilityChanged(int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07007199 if (visibility == VISIBLE) {
7200 initialAwakenScrollBars();
7201 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007202 }
7203
7204 /**
7205 * Returns the current visibility of the window this view is attached to
7206 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}).
7207 *
7208 * @return Returns the current visibility of the view's window.
7209 */
7210 public int getWindowVisibility() {
7211 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE;
7212 }
7213
7214 /**
7215 * Retrieve the overall visible display size in which the window this view is
7216 * attached to has been positioned in. This takes into account screen
7217 * decorations above the window, for both cases where the window itself
7218 * is being position inside of them or the window is being placed under
7219 * then and covered insets are used for the window to position its content
7220 * inside. In effect, this tells you the available area where content can
7221 * be placed and remain visible to users.
7222 *
7223 * <p>This function requires an IPC back to the window manager to retrieve
7224 * the requested information, so should not be used in performance critical
7225 * code like drawing.
7226 *
7227 * @param outRect Filled in with the visible display frame. If the view
7228 * is not attached to a window, this is simply the raw display size.
7229 */
7230 public void getWindowVisibleDisplayFrame(Rect outRect) {
7231 if (mAttachInfo != null) {
7232 try {
7233 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect);
7234 } catch (RemoteException e) {
7235 return;
7236 }
7237 // XXX This is really broken, and probably all needs to be done
7238 // in the window manager, and we need to know more about whether
7239 // we want the area behind or in front of the IME.
7240 final Rect insets = mAttachInfo.mVisibleInsets;
7241 outRect.left += insets.left;
7242 outRect.top += insets.top;
7243 outRect.right -= insets.right;
7244 outRect.bottom -= insets.bottom;
7245 return;
7246 }
7247 Display d = WindowManagerImpl.getDefault().getDefaultDisplay();
Dianne Hackborn44bc17c2011-04-20 18:18:51 -07007248 d.getRectSize(outRect);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007249 }
7250
7251 /**
Dianne Hackborne36d6e22010-02-17 19:46:25 -08007252 * Dispatch a notification about a resource configuration change down
7253 * the view hierarchy.
7254 * ViewGroups should override to route to their children.
7255 *
7256 * @param newConfig The new resource configuration.
7257 *
Philip Milne6c8ea062012-04-03 17:38:43 -07007258 * @see #onConfigurationChanged(android.content.res.Configuration)
Dianne Hackborne36d6e22010-02-17 19:46:25 -08007259 */
7260 public void dispatchConfigurationChanged(Configuration newConfig) {
7261 onConfigurationChanged(newConfig);
7262 }
7263
7264 /**
7265 * Called when the current configuration of the resources being used
7266 * by the application have changed. You can use this to decide when
7267 * to reload resources that can changed based on orientation and other
7268 * configuration characterstics. You only need to use this if you are
7269 * not relying on the normal {@link android.app.Activity} mechanism of
7270 * recreating the activity instance upon a configuration change.
7271 *
7272 * @param newConfig The new resource configuration.
7273 */
7274 protected void onConfigurationChanged(Configuration newConfig) {
7275 }
7276
7277 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007278 * Private function to aggregate all per-view attributes in to the view
7279 * root.
7280 */
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007281 void dispatchCollectViewAttributes(AttachInfo attachInfo, int visibility) {
7282 performCollectViewAttributes(attachInfo, visibility);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007283 }
7284
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007285 void performCollectViewAttributes(AttachInfo attachInfo, int visibility) {
7286 if ((visibility & VISIBILITY_MASK) == VISIBLE) {
Joe Onorato664644d2011-01-23 17:53:23 -08007287 if ((mViewFlags & KEEP_SCREEN_ON) == KEEP_SCREEN_ON) {
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007288 attachInfo.mKeepScreenOn = true;
Joe Onorato664644d2011-01-23 17:53:23 -08007289 }
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007290 attachInfo.mSystemUiVisibility |= mSystemUiVisibility;
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07007291 ListenerInfo li = mListenerInfo;
7292 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) {
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007293 attachInfo.mHasSystemUiListeners = true;
Joe Onorato664644d2011-01-23 17:53:23 -08007294 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007295 }
7296 }
7297
7298 void needGlobalAttributesUpdate(boolean force) {
Joe Onorato664644d2011-01-23 17:53:23 -08007299 final AttachInfo ai = mAttachInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007300 if (ai != null) {
Joe Onorato664644d2011-01-23 17:53:23 -08007301 if (force || ai.mKeepScreenOn || (ai.mSystemUiVisibility != 0)
7302 || ai.mHasSystemUiListeners) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007303 ai.mRecomputeGlobalAttributes = true;
7304 }
7305 }
7306 }
7307
7308 /**
7309 * Returns whether the device is currently in touch mode. Touch mode is entered
7310 * once the user begins interacting with the device by touch, and affects various
7311 * things like whether focus is always visible to the user.
7312 *
7313 * @return Whether the device is in touch mode.
7314 */
7315 @ViewDebug.ExportedProperty
7316 public boolean isInTouchMode() {
7317 if (mAttachInfo != null) {
7318 return mAttachInfo.mInTouchMode;
7319 } else {
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07007320 return ViewRootImpl.isInTouchMode();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007321 }
7322 }
7323
7324 /**
7325 * Returns the context the view is running in, through which it can
7326 * access the current theme, resources, etc.
7327 *
7328 * @return The view's Context.
7329 */
7330 @ViewDebug.CapturedViewProperty
7331 public final Context getContext() {
7332 return mContext;
7333 }
7334
7335 /**
7336 * Handle a key event before it is processed by any input method
7337 * associated with the view hierarchy. This can be used to intercept
7338 * key events in special situations before the IME consumes them; a
7339 * typical example would be handling the BACK key to update the application's
7340 * UI instead of allowing the IME to see it and close itself.
7341 *
7342 * @param keyCode The value in event.getKeyCode().
7343 * @param event Description of the key event.
7344 * @return If you handled the event, return true. If you want to allow the
7345 * event to be handled by the next receiver, return false.
7346 */
7347 public boolean onKeyPreIme(int keyCode, KeyEvent event) {
7348 return false;
7349 }
7350
7351 /**
Jeff Brown995e7742010-12-22 16:59:36 -08007352 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent)
7353 * KeyEvent.Callback.onKeyDown()}: perform press of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007354 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER}
7355 * is released, if the view is enabled and clickable.
7356 *
7357 * @param keyCode A key code that represents the button pressed, from
7358 * {@link android.view.KeyEvent}.
7359 * @param event The KeyEvent object that defines the button action.
7360 */
7361 public boolean onKeyDown(int keyCode, KeyEvent event) {
7362 boolean result = false;
7363
7364 switch (keyCode) {
7365 case KeyEvent.KEYCODE_DPAD_CENTER:
7366 case KeyEvent.KEYCODE_ENTER: {
7367 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
7368 return true;
7369 }
7370 // Long clickable items don't necessarily have to be clickable
7371 if (((mViewFlags & CLICKABLE) == CLICKABLE ||
7372 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) &&
7373 (event.getRepeatCount() == 0)) {
7374 setPressed(true);
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007375 checkForLongClick(0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007376 return true;
7377 }
7378 break;
7379 }
7380 }
7381 return result;
7382 }
7383
7384 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07007385 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
7386 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle
7387 * the event).
7388 */
7389 public boolean onKeyLongPress(int keyCode, KeyEvent event) {
7390 return false;
7391 }
7392
7393 /**
Jeff Brown995e7742010-12-22 16:59:36 -08007394 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent)
7395 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007396 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or
7397 * {@link KeyEvent#KEYCODE_ENTER} is released.
7398 *
7399 * @param keyCode A key code that represents the button pressed, from
7400 * {@link android.view.KeyEvent}.
7401 * @param event The KeyEvent object that defines the button action.
7402 */
7403 public boolean onKeyUp(int keyCode, KeyEvent event) {
7404 boolean result = false;
7405
7406 switch (keyCode) {
7407 case KeyEvent.KEYCODE_DPAD_CENTER:
7408 case KeyEvent.KEYCODE_ENTER: {
7409 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
7410 return true;
7411 }
7412 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) {
7413 setPressed(false);
7414
7415 if (!mHasPerformedLongPress) {
7416 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05007417 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007418
7419 result = performClick();
7420 }
7421 }
7422 break;
7423 }
7424 }
7425 return result;
7426 }
7427
7428 /**
7429 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
7430 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle
7431 * the event).
7432 *
7433 * @param keyCode A key code that represents the button pressed, from
7434 * {@link android.view.KeyEvent}.
7435 * @param repeatCount The number of times the action was made.
7436 * @param event The KeyEvent object that defines the button action.
7437 */
7438 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
7439 return false;
7440 }
7441
7442 /**
Jeff Brown64da12a2011-01-04 19:57:47 -08007443 * Called on the focused view when a key shortcut event is not handled.
7444 * Override this method to implement local key shortcuts for the View.
7445 * Key shortcuts can also be implemented by setting the
7446 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007447 *
7448 * @param keyCode The value in event.getKeyCode().
7449 * @param event Description of the key event.
7450 * @return If you handled the event, return true. If you want to allow the
7451 * event to be handled by the next receiver, return false.
7452 */
7453 public boolean onKeyShortcut(int keyCode, KeyEvent event) {
7454 return false;
7455 }
7456
7457 /**
7458 * Check whether the called view is a text editor, in which case it
7459 * would make sense to automatically display a soft input window for
7460 * it. Subclasses should override this if they implement
7461 * {@link #onCreateInputConnection(EditorInfo)} to return true if
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007462 * a call on that method would return a non-null InputConnection, and
7463 * they are really a first-class editor that the user would normally
7464 * start typing on when the go into a window containing your view.
Romain Guy8506ab42009-06-11 17:35:47 -07007465 *
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007466 * <p>The default implementation always returns false. This does
7467 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)}
7468 * will not be called or the user can not otherwise perform edits on your
7469 * view; it is just a hint to the system that this is not the primary
7470 * purpose of this view.
Romain Guy8506ab42009-06-11 17:35:47 -07007471 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007472 * @return Returns true if this view is a text editor, else false.
7473 */
7474 public boolean onCheckIsTextEditor() {
7475 return false;
7476 }
Romain Guy8506ab42009-06-11 17:35:47 -07007477
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007478 /**
7479 * Create a new InputConnection for an InputMethod to interact
7480 * with the view. The default implementation returns null, since it doesn't
7481 * support input methods. You can override this to implement such support.
7482 * This is only needed for views that take focus and text input.
Romain Guy8506ab42009-06-11 17:35:47 -07007483 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007484 * <p>When implementing this, you probably also want to implement
7485 * {@link #onCheckIsTextEditor()} to indicate you will return a
7486 * non-null InputConnection.
7487 *
7488 * @param outAttrs Fill in with attribute information about the connection.
7489 */
7490 public InputConnection onCreateInputConnection(EditorInfo outAttrs) {
7491 return null;
7492 }
7493
7494 /**
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007495 * Called by the {@link android.view.inputmethod.InputMethodManager}
7496 * when a view who is not the current
7497 * input connection target is trying to make a call on the manager. The
7498 * default implementation returns false; you can override this to return
7499 * true for certain views if you are performing InputConnection proxying
7500 * to them.
7501 * @param view The View that is making the InputMethodManager call.
7502 * @return Return true to allow the call, false to reject.
7503 */
7504 public boolean checkInputConnectionProxy(View view) {
7505 return false;
7506 }
Romain Guy8506ab42009-06-11 17:35:47 -07007507
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007508 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007509 * Show the context menu for this view. It is not safe to hold on to the
7510 * menu after returning from this method.
7511 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07007512 * You should normally not overload this method. Overload
7513 * {@link #onCreateContextMenu(ContextMenu)} or define an
7514 * {@link OnCreateContextMenuListener} to add items to the context menu.
7515 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007516 * @param menu The context menu to populate
7517 */
7518 public void createContextMenu(ContextMenu menu) {
7519 ContextMenuInfo menuInfo = getContextMenuInfo();
7520
7521 // Sets the current menu info so all items added to menu will have
7522 // my extra info set.
7523 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo);
7524
7525 onCreateContextMenu(menu);
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07007526 ListenerInfo li = mListenerInfo;
7527 if (li != null && li.mOnCreateContextMenuListener != null) {
7528 li.mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007529 }
7530
7531 // Clear the extra information so subsequent items that aren't mine don't
7532 // have my extra info.
7533 ((MenuBuilder)menu).setCurrentMenuInfo(null);
7534
7535 if (mParent != null) {
7536 mParent.createContextMenu(menu);
7537 }
7538 }
7539
7540 /**
7541 * Views should implement this if they have extra information to associate
7542 * with the context menu. The return result is supplied as a parameter to
7543 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)}
7544 * callback.
7545 *
7546 * @return Extra information about the item for which the context menu
7547 * should be shown. This information will vary across different
7548 * subclasses of View.
7549 */
7550 protected ContextMenuInfo getContextMenuInfo() {
7551 return null;
7552 }
7553
7554 /**
7555 * Views should implement this if the view itself is going to add items to
7556 * the context menu.
7557 *
7558 * @param menu the context menu to populate
7559 */
7560 protected void onCreateContextMenu(ContextMenu menu) {
7561 }
7562
7563 /**
7564 * Implement this method to handle trackball motion events. The
7565 * <em>relative</em> movement of the trackball since the last event
7566 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and
7567 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so
7568 * that a movement of 1 corresponds to the user pressing one DPAD key (so
7569 * they will often be fractional values, representing the more fine-grained
7570 * movement information available from a trackball).
7571 *
7572 * @param event The motion event.
7573 * @return True if the event was handled, false otherwise.
7574 */
7575 public boolean onTrackballEvent(MotionEvent event) {
7576 return false;
7577 }
7578
7579 /**
Jeff Browncb1404e2011-01-15 18:14:15 -08007580 * Implement this method to handle generic motion events.
7581 * <p>
Jeff Brown33bbfd22011-02-24 20:55:35 -08007582 * Generic motion events describe joystick movements, mouse hovers, track pad
7583 * touches, scroll wheel movements and other input events. The
Jeff Browncb1404e2011-01-15 18:14:15 -08007584 * {@link MotionEvent#getSource() source} of the motion event specifies
7585 * the class of input that was received. Implementations of this method
7586 * must examine the bits in the source before processing the event.
7587 * The following code example shows how this is done.
Jeff Brown33bbfd22011-02-24 20:55:35 -08007588 * </p><p>
7589 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER}
7590 * are delivered to the view under the pointer. All other generic motion events are
7591 * delivered to the focused view.
Jeff Browncb1404e2011-01-15 18:14:15 -08007592 * </p>
Scott Mainb303d832011-10-12 16:45:18 -07007593 * <pre> public boolean onGenericMotionEvent(MotionEvent event) {
Jeff Browncb1404e2011-01-15 18:14:15 -08007594 * if ((event.getSource() &amp; InputDevice.SOURCE_CLASS_JOYSTICK) != 0) {
Jeff Brown33bbfd22011-02-24 20:55:35 -08007595 * if (event.getAction() == MotionEvent.ACTION_MOVE) {
7596 * // process the joystick movement...
7597 * return true;
7598 * }
7599 * }
7600 * if ((event.getSource() &amp; InputDevice.SOURCE_CLASS_POINTER) != 0) {
7601 * switch (event.getAction()) {
7602 * case MotionEvent.ACTION_HOVER_MOVE:
7603 * // process the mouse hover movement...
7604 * return true;
7605 * case MotionEvent.ACTION_SCROLL:
7606 * // process the scroll wheel movement...
7607 * return true;
7608 * }
Jeff Browncb1404e2011-01-15 18:14:15 -08007609 * }
7610 * return super.onGenericMotionEvent(event);
Scott Mainb303d832011-10-12 16:45:18 -07007611 * }</pre>
Jeff Browncb1404e2011-01-15 18:14:15 -08007612 *
7613 * @param event The generic motion event being processed.
Jeff Browna032cc02011-03-07 16:56:21 -08007614 * @return True if the event was handled, false otherwise.
Jeff Browncb1404e2011-01-15 18:14:15 -08007615 */
7616 public boolean onGenericMotionEvent(MotionEvent event) {
7617 return false;
7618 }
7619
7620 /**
Jeff Browna032cc02011-03-07 16:56:21 -08007621 * Implement this method to handle hover events.
7622 * <p>
Jeff Brown10b62902011-06-20 16:40:37 -07007623 * This method is called whenever a pointer is hovering into, over, or out of the
7624 * bounds of a view and the view is not currently being touched.
7625 * Hover events are represented as pointer events with action
7626 * {@link MotionEvent#ACTION_HOVER_ENTER}, {@link MotionEvent#ACTION_HOVER_MOVE},
7627 * or {@link MotionEvent#ACTION_HOVER_EXIT}.
7628 * </p>
7629 * <ul>
7630 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_ENTER}
7631 * when the pointer enters the bounds of the view.</li>
7632 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_MOVE}
7633 * when the pointer has already entered the bounds of the view and has moved.</li>
7634 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_EXIT}
7635 * when the pointer has exited the bounds of the view or when the pointer is
7636 * about to go down due to a button click, tap, or similar user action that
7637 * causes the view to be touched.</li>
7638 * </ul>
7639 * <p>
7640 * The view should implement this method to return true to indicate that it is
7641 * handling the hover event, such as by changing its drawable state.
Jeff Browna032cc02011-03-07 16:56:21 -08007642 * </p><p>
Jeff Brown10b62902011-06-20 16:40:37 -07007643 * The default implementation calls {@link #setHovered} to update the hovered state
7644 * of the view when a hover enter or hover exit event is received, if the view
Jeff Browna1b24182011-07-28 13:38:24 -07007645 * is enabled and is clickable. The default implementation also sends hover
7646 * accessibility events.
Jeff Browna032cc02011-03-07 16:56:21 -08007647 * </p>
7648 *
7649 * @param event The motion event that describes the hover.
Jeff Brown10b62902011-06-20 16:40:37 -07007650 * @return True if the view handled the hover event.
7651 *
7652 * @see #isHovered
7653 * @see #setHovered
7654 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08007655 */
7656 public boolean onHoverEvent(MotionEvent event) {
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007657 // The root view may receive hover (or touch) events that are outside the bounds of
7658 // the window. This code ensures that we only send accessibility events for
7659 // hovers that are actually within the bounds of the root view.
Svetoslav Ganov42138042012-03-20 11:51:39 -07007660 final int action = event.getActionMasked();
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007661 if (!mSendingHoverAccessibilityEvents) {
7662 if ((action == MotionEvent.ACTION_HOVER_ENTER
7663 || action == MotionEvent.ACTION_HOVER_MOVE)
7664 && !hasHoveredChild()
7665 && pointInView(event.getX(), event.getY())) {
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007666 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_HOVER_ENTER);
Svetoslav Ganov42138042012-03-20 11:51:39 -07007667 mSendingHoverAccessibilityEvents = true;
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07007668 requestAccessibilityFocusFromHover();
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007669 }
7670 } else {
7671 if (action == MotionEvent.ACTION_HOVER_EXIT
Svetoslav Ganov42138042012-03-20 11:51:39 -07007672 || (action == MotionEvent.ACTION_MOVE
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007673 && !pointInView(event.getX(), event.getY()))) {
7674 mSendingHoverAccessibilityEvents = false;
7675 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_HOVER_EXIT);
Svetoslav Ganov42138042012-03-20 11:51:39 -07007676 // If the window does not have input focus we take away accessibility
7677 // focus as soon as the user stop hovering over the view.
Jeff Brown59a422e2012-04-19 15:19:19 -07007678 if (mAttachInfo != null && !mAttachInfo.mHasWindowFocus) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07007679 getViewRootImpl().setAccessibilityFocusedHost(null);
7680 }
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007681 }
Jeff Browna1b24182011-07-28 13:38:24 -07007682 }
7683
Jeff Brown87b7f802011-06-21 18:35:45 -07007684 if (isHoverable()) {
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007685 switch (action) {
Jeff Brown10b62902011-06-20 16:40:37 -07007686 case MotionEvent.ACTION_HOVER_ENTER:
7687 setHovered(true);
7688 break;
7689 case MotionEvent.ACTION_HOVER_EXIT:
7690 setHovered(false);
7691 break;
7692 }
Jeff Browna1b24182011-07-28 13:38:24 -07007693
7694 // Dispatch the event to onGenericMotionEvent before returning true.
7695 // This is to provide compatibility with existing applications that
7696 // handled HOVER_MOVE events in onGenericMotionEvent and that would
7697 // break because of the new default handling for hoverable views
7698 // in onHoverEvent.
7699 // Note that onGenericMotionEvent will be called by default when
7700 // onHoverEvent returns false (refer to dispatchGenericMotionEvent).
7701 dispatchGenericMotionEventInternal(event);
Jeff Brown10b62902011-06-20 16:40:37 -07007702 return true;
Jeff Browna032cc02011-03-07 16:56:21 -08007703 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07007704
Svetoslav Ganov736c2752011-04-22 18:30:36 -07007705 return false;
Jeff Browna032cc02011-03-07 16:56:21 -08007706 }
7707
7708 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07007709 * Returns true if the view should handle {@link #onHoverEvent}
7710 * by calling {@link #setHovered} to change its hovered state.
7711 *
7712 * @return True if the view is hoverable.
7713 */
7714 private boolean isHoverable() {
7715 final int viewFlags = mViewFlags;
7716 if ((viewFlags & ENABLED_MASK) == DISABLED) {
7717 return false;
7718 }
7719
7720 return (viewFlags & CLICKABLE) == CLICKABLE
7721 || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
7722 }
7723
7724 /**
Jeff Browna032cc02011-03-07 16:56:21 -08007725 * Returns true if the view is currently hovered.
7726 *
7727 * @return True if the view is currently hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07007728 *
7729 * @see #setHovered
7730 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08007731 */
Jeff Brown10b62902011-06-20 16:40:37 -07007732 @ViewDebug.ExportedProperty
Jeff Browna032cc02011-03-07 16:56:21 -08007733 public boolean isHovered() {
7734 return (mPrivateFlags & HOVERED) != 0;
7735 }
7736
7737 /**
7738 * Sets whether the view is currently hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07007739 * <p>
7740 * Calling this method also changes the drawable state of the view. This
7741 * enables the view to react to hover by using different drawable resources
7742 * to change its appearance.
7743 * </p><p>
7744 * The {@link #onHoverChanged} method is called when the hovered state changes.
7745 * </p>
Jeff Browna032cc02011-03-07 16:56:21 -08007746 *
7747 * @param hovered True if the view is hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07007748 *
7749 * @see #isHovered
7750 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08007751 */
7752 public void setHovered(boolean hovered) {
7753 if (hovered) {
7754 if ((mPrivateFlags & HOVERED) == 0) {
7755 mPrivateFlags |= HOVERED;
7756 refreshDrawableState();
Jeff Brown10b62902011-06-20 16:40:37 -07007757 onHoverChanged(true);
Jeff Browna032cc02011-03-07 16:56:21 -08007758 }
7759 } else {
7760 if ((mPrivateFlags & HOVERED) != 0) {
7761 mPrivateFlags &= ~HOVERED;
7762 refreshDrawableState();
Jeff Brown10b62902011-06-20 16:40:37 -07007763 onHoverChanged(false);
Jeff Browna032cc02011-03-07 16:56:21 -08007764 }
7765 }
7766 }
7767
7768 /**
Jeff Brown10b62902011-06-20 16:40:37 -07007769 * Implement this method to handle hover state changes.
7770 * <p>
7771 * This method is called whenever the hover state changes as a result of a
7772 * call to {@link #setHovered}.
7773 * </p>
7774 *
7775 * @param hovered The current hover state, as returned by {@link #isHovered}.
7776 *
7777 * @see #isHovered
7778 * @see #setHovered
7779 */
7780 public void onHoverChanged(boolean hovered) {
Jeff Brown10b62902011-06-20 16:40:37 -07007781 }
7782
7783 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007784 * Implement this method to handle touch screen motion events.
7785 *
7786 * @param event The motion event.
7787 * @return True if the event was handled, false otherwise.
7788 */
7789 public boolean onTouchEvent(MotionEvent event) {
7790 final int viewFlags = mViewFlags;
7791
7792 if ((viewFlags & ENABLED_MASK) == DISABLED) {
Svetoslav Ganov77b80c02011-03-15 20:52:58 -07007793 if (event.getAction() == MotionEvent.ACTION_UP && (mPrivateFlags & PRESSED) != 0) {
Adam Powell4d6f0662012-02-21 15:11:11 -08007794 setPressed(false);
Svetoslav Ganov77b80c02011-03-15 20:52:58 -07007795 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007796 // A disabled view that is clickable still consumes the touch
7797 // events, it just doesn't respond to them.
7798 return (((viewFlags & CLICKABLE) == CLICKABLE ||
7799 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE));
7800 }
7801
7802 if (mTouchDelegate != null) {
7803 if (mTouchDelegate.onTouchEvent(event)) {
7804 return true;
7805 }
7806 }
7807
7808 if (((viewFlags & CLICKABLE) == CLICKABLE ||
7809 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) {
7810 switch (event.getAction()) {
7811 case MotionEvent.ACTION_UP:
Adam Powelle14579b2009-12-16 18:39:52 -08007812 boolean prepressed = (mPrivateFlags & PREPRESSED) != 0;
7813 if ((mPrivateFlags & PRESSED) != 0 || prepressed) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007814 // take focus if we don't have it already and we should in
7815 // touch mode.
7816 boolean focusTaken = false;
7817 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) {
7818 focusTaken = requestFocus();
7819 }
7820
Dianne Hackbornbe1f6222011-01-20 15:24:28 -08007821 if (prepressed) {
7822 // The button is being released before we actually
7823 // showed it as pressed. Make it show the pressed
7824 // state now (before scheduling the click) to ensure
7825 // the user sees it.
Adam Powell4d6f0662012-02-21 15:11:11 -08007826 setPressed(true);
Dianne Hackbornbe1f6222011-01-20 15:24:28 -08007827 }
Joe Malin32736f02011-01-19 16:14:20 -08007828
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007829 if (!mHasPerformedLongPress) {
7830 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05007831 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007832
7833 // Only perform take click actions if we were in the pressed state
7834 if (!focusTaken) {
Adam Powella35d7682010-03-12 14:48:13 -08007835 // Use a Runnable and post this rather than calling
7836 // performClick directly. This lets other visual state
7837 // of the view update before click actions start.
7838 if (mPerformClick == null) {
7839 mPerformClick = new PerformClick();
7840 }
7841 if (!post(mPerformClick)) {
7842 performClick();
7843 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007844 }
7845 }
7846
7847 if (mUnsetPressedState == null) {
7848 mUnsetPressedState = new UnsetPressedState();
7849 }
7850
Adam Powelle14579b2009-12-16 18:39:52 -08007851 if (prepressed) {
Adam Powelle14579b2009-12-16 18:39:52 -08007852 postDelayed(mUnsetPressedState,
7853 ViewConfiguration.getPressedStateDuration());
7854 } else if (!post(mUnsetPressedState)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007855 // If the post failed, unpress right now
7856 mUnsetPressedState.run();
7857 }
Adam Powelle14579b2009-12-16 18:39:52 -08007858 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007859 }
7860 break;
7861
7862 case MotionEvent.ACTION_DOWN:
Adam Powell3b023392010-03-11 16:30:28 -08007863 mHasPerformedLongPress = false;
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007864
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07007865 if (performButtonActionOnTouchDown(event)) {
7866 break;
7867 }
7868
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007869 // Walk up the hierarchy to determine if we're inside a scrolling container.
Adam Powell10298662011-08-14 18:26:30 -07007870 boolean isInScrollingContainer = isInScrollingContainer();
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007871
7872 // For views inside a scrolling container, delay the pressed feedback for
7873 // a short period in case this is a scroll.
7874 if (isInScrollingContainer) {
7875 mPrivateFlags |= PREPRESSED;
7876 if (mPendingCheckForTap == null) {
7877 mPendingCheckForTap = new CheckForTap();
7878 }
7879 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout());
7880 } else {
7881 // Not inside a scrolling container, so show the feedback right away
Adam Powell4d6f0662012-02-21 15:11:11 -08007882 setPressed(true);
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007883 checkForLongClick(0);
7884 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007885 break;
7886
7887 case MotionEvent.ACTION_CANCEL:
Adam Powell4d6f0662012-02-21 15:11:11 -08007888 setPressed(false);
Adam Powelle14579b2009-12-16 18:39:52 -08007889 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007890 break;
7891
7892 case MotionEvent.ACTION_MOVE:
7893 final int x = (int) event.getX();
7894 final int y = (int) event.getY();
7895
7896 // Be lenient about moving outside of buttons
Chet Haasec3aa3612010-06-17 08:50:37 -07007897 if (!pointInView(x, y, mTouchSlop)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007898 // Outside button
Adam Powelle14579b2009-12-16 18:39:52 -08007899 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007900 if ((mPrivateFlags & PRESSED) != 0) {
Adam Powelle14579b2009-12-16 18:39:52 -08007901 // Remove any future long press/tap checks
Maryam Garrett1549dd12009-12-15 16:06:36 -05007902 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007903
Adam Powell4d6f0662012-02-21 15:11:11 -08007904 setPressed(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007905 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007906 }
7907 break;
7908 }
7909 return true;
7910 }
7911
7912 return false;
7913 }
7914
7915 /**
Adam Powell10298662011-08-14 18:26:30 -07007916 * @hide
7917 */
7918 public boolean isInScrollingContainer() {
7919 ViewParent p = getParent();
7920 while (p != null && p instanceof ViewGroup) {
7921 if (((ViewGroup) p).shouldDelayChildPressedState()) {
7922 return true;
7923 }
7924 p = p.getParent();
7925 }
7926 return false;
7927 }
7928
7929 /**
Maryam Garrett1549dd12009-12-15 16:06:36 -05007930 * Remove the longpress detection timer.
7931 */
7932 private void removeLongPressCallback() {
7933 if (mPendingCheckForLongPress != null) {
7934 removeCallbacks(mPendingCheckForLongPress);
7935 }
7936 }
Adam Powell3cb8b632011-01-21 15:34:14 -08007937
7938 /**
7939 * Remove the pending click action
7940 */
7941 private void removePerformClickCallback() {
7942 if (mPerformClick != null) {
7943 removeCallbacks(mPerformClick);
7944 }
7945 }
7946
Adam Powelle14579b2009-12-16 18:39:52 -08007947 /**
Romain Guya440b002010-02-24 15:57:54 -08007948 * Remove the prepress detection timer.
7949 */
7950 private void removeUnsetPressCallback() {
7951 if ((mPrivateFlags & PRESSED) != 0 && mUnsetPressedState != null) {
7952 setPressed(false);
7953 removeCallbacks(mUnsetPressedState);
7954 }
7955 }
7956
7957 /**
Adam Powelle14579b2009-12-16 18:39:52 -08007958 * Remove the tap detection timer.
7959 */
7960 private void removeTapCallback() {
7961 if (mPendingCheckForTap != null) {
7962 mPrivateFlags &= ~PREPRESSED;
7963 removeCallbacks(mPendingCheckForTap);
7964 }
7965 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05007966
7967 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007968 * Cancels a pending long press. Your subclass can use this if you
7969 * want the context menu to come up if the user presses and holds
7970 * at the same place, but you don't want it to come up if they press
7971 * and then move around enough to cause scrolling.
7972 */
7973 public void cancelLongPress() {
Maryam Garrett1549dd12009-12-15 16:06:36 -05007974 removeLongPressCallback();
Adam Powell732ebb12010-02-02 15:28:14 -08007975
7976 /*
7977 * The prepressed state handled by the tap callback is a display
7978 * construct, but the tap callback will post a long press callback
7979 * less its own timeout. Remove it here.
7980 */
7981 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007982 }
7983
7984 /**
Svetoslav Ganova0156172011-06-26 17:55:44 -07007985 * Remove the pending callback for sending a
7986 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event.
7987 */
7988 private void removeSendViewScrolledAccessibilityEventCallback() {
7989 if (mSendViewScrolledAccessibilityEvent != null) {
7990 removeCallbacks(mSendViewScrolledAccessibilityEvent);
7991 }
7992 }
7993
7994 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007995 * Sets the TouchDelegate for this View.
7996 */
7997 public void setTouchDelegate(TouchDelegate delegate) {
7998 mTouchDelegate = delegate;
7999 }
8000
8001 /**
8002 * Gets the TouchDelegate for this View.
8003 */
8004 public TouchDelegate getTouchDelegate() {
8005 return mTouchDelegate;
8006 }
8007
8008 /**
8009 * Set flags controlling behavior of this view.
8010 *
8011 * @param flags Constant indicating the value which should be set
8012 * @param mask Constant indicating the bit range that should be changed
8013 */
8014 void setFlags(int flags, int mask) {
8015 int old = mViewFlags;
8016 mViewFlags = (mViewFlags & ~mask) | (flags & mask);
8017
8018 int changed = mViewFlags ^ old;
8019 if (changed == 0) {
8020 return;
8021 }
8022 int privateFlags = mPrivateFlags;
8023
8024 /* Check if the FOCUSABLE bit has changed */
8025 if (((changed & FOCUSABLE_MASK) != 0) &&
8026 ((privateFlags & HAS_BOUNDS) !=0)) {
8027 if (((old & FOCUSABLE_MASK) == FOCUSABLE)
8028 && ((privateFlags & FOCUSED) != 0)) {
8029 /* Give up focus if we are no longer focusable */
8030 clearFocus();
8031 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE)
8032 && ((privateFlags & FOCUSED) == 0)) {
8033 /*
8034 * Tell the view system that we are now available to take focus
8035 * if no one else already has it.
8036 */
8037 if (mParent != null) mParent.focusableViewAvailable(this);
8038 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07008039 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
8040 notifyAccessibilityStateChanged();
8041 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008042 }
8043
8044 if ((flags & VISIBILITY_MASK) == VISIBLE) {
8045 if ((changed & VISIBILITY_MASK) != 0) {
8046 /*
Chet Haase4324ead2011-08-24 21:31:03 -07008047 * If this view is becoming visible, invalidate it in case it changed while
Chet Haaseaceafe62011-08-26 15:44:33 -07008048 * it was not visible. Marking it drawn ensures that the invalidation will
8049 * go through.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008050 */
Chet Haaseaceafe62011-08-26 15:44:33 -07008051 mPrivateFlags |= DRAWN;
Chet Haase4324ead2011-08-24 21:31:03 -07008052 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008053
8054 needGlobalAttributesUpdate(true);
8055
8056 // a view becoming visible is worth notifying the parent
8057 // about in case nothing has focus. even if this specific view
8058 // isn't focusable, it may contain something that is, so let
8059 // the root view try to give this focus if nothing else does.
8060 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) {
8061 mParent.focusableViewAvailable(this);
8062 }
8063 }
8064 }
8065
8066 /* Check if the GONE bit has changed */
8067 if ((changed & GONE) != 0) {
8068 needGlobalAttributesUpdate(false);
8069 requestLayout();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008070
Romain Guyecd80ee2009-12-03 17:13:02 -08008071 if (((mViewFlags & VISIBILITY_MASK) == GONE)) {
8072 if (hasFocus()) clearFocus();
Svetoslav Ganov42138042012-03-20 11:51:39 -07008073 clearAccessibilityFocus();
Romain Guyecd80ee2009-12-03 17:13:02 -08008074 destroyDrawingCache();
Chet Haaseaceafe62011-08-26 15:44:33 -07008075 if (mParent instanceof View) {
8076 // GONE views noop invalidation, so invalidate the parent
8077 ((View) mParent).invalidate(true);
8078 }
8079 // Mark the view drawn to ensure that it gets invalidated properly the next
8080 // time it is visible and gets invalidated
8081 mPrivateFlags |= DRAWN;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008082 }
8083 if (mAttachInfo != null) {
8084 mAttachInfo.mViewVisibilityChanged = true;
8085 }
8086 }
8087
8088 /* Check if the VISIBLE bit has changed */
8089 if ((changed & INVISIBLE) != 0) {
8090 needGlobalAttributesUpdate(false);
Chet Haasec8a9a702011-06-17 12:13:42 -07008091 /*
8092 * If this view is becoming invisible, set the DRAWN flag so that
8093 * the next invalidate() will not be skipped.
8094 */
8095 mPrivateFlags |= DRAWN;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008096
8097 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07008098 // root view becoming invisible shouldn't clear focus and accessibility focus
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008099 if (getRootView() != this) {
8100 clearFocus();
Svetoslav Ganov42138042012-03-20 11:51:39 -07008101 clearAccessibilityFocus();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008102 }
8103 }
8104 if (mAttachInfo != null) {
8105 mAttachInfo.mViewVisibilityChanged = true;
8106 }
8107 }
8108
Adam Powell326d8082009-12-09 15:10:07 -08008109 if ((changed & VISIBILITY_MASK) != 0) {
Chet Haase5e25c2c2010-09-16 11:15:56 -07008110 if (mParent instanceof ViewGroup) {
Romain Guyfe455af2012-02-15 16:40:20 -08008111 ((ViewGroup) mParent).onChildVisibilityChanged(this,
8112 (changed & VISIBILITY_MASK), (flags & VISIBILITY_MASK));
Romain Guy0fd89bf2011-01-26 15:41:30 -08008113 ((View) mParent).invalidate(true);
Chet Haasee4e6e202011-08-29 14:34:30 -07008114 } else if (mParent != null) {
8115 mParent.invalidateChild(this, null);
Chet Haase5e25c2c2010-09-16 11:15:56 -07008116 }
Adam Powell326d8082009-12-09 15:10:07 -08008117 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK));
8118 }
8119
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008120 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) {
8121 destroyDrawingCache();
8122 }
8123
8124 if ((changed & DRAWING_CACHE_ENABLED) != 0) {
8125 destroyDrawingCache();
8126 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Romain Guy0fd89bf2011-01-26 15:41:30 -08008127 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008128 }
8129
8130 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) {
8131 destroyDrawingCache();
8132 mPrivateFlags &= ~DRAWING_CACHE_VALID;
8133 }
8134
8135 if ((changed & DRAW_MASK) != 0) {
8136 if ((mViewFlags & WILL_NOT_DRAW) != 0) {
Philip Milne6c8ea062012-04-03 17:38:43 -07008137 if (mBackground != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008138 mPrivateFlags &= ~SKIP_DRAW;
8139 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
8140 } else {
8141 mPrivateFlags |= SKIP_DRAW;
8142 }
8143 } else {
8144 mPrivateFlags &= ~SKIP_DRAW;
8145 }
8146 requestLayout();
Romain Guy0fd89bf2011-01-26 15:41:30 -08008147 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008148 }
8149
8150 if ((changed & KEEP_SCREEN_ON) != 0) {
Joe Onorato664644d2011-01-23 17:53:23 -08008151 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008152 mParent.recomputeViewAttributes(this);
8153 }
8154 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07008155
8156 if (AccessibilityManager.getInstance(mContext).isEnabled()
8157 && ((changed & FOCUSABLE) != 0 || (changed & CLICKABLE) != 0
8158 || (changed & LONG_CLICKABLE) != 0 || (changed & ENABLED) != 0)) {
8159 notifyAccessibilityStateChanged();
8160 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008161 }
8162
8163 /**
8164 * Change the view's z order in the tree, so it's on top of other sibling
8165 * views
8166 */
8167 public void bringToFront() {
8168 if (mParent != null) {
8169 mParent.bringChildToFront(this);
8170 }
8171 }
8172
8173 /**
8174 * This is called in response to an internal scroll in this view (i.e., the
8175 * view scrolled its own contents). This is typically as a result of
8176 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been
8177 * called.
8178 *
8179 * @param l Current horizontal scroll origin.
8180 * @param t Current vertical scroll origin.
8181 * @param oldl Previous horizontal scroll origin.
8182 * @param oldt Previous vertical scroll origin.
8183 */
8184 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
Svetoslav Ganova0156172011-06-26 17:55:44 -07008185 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
8186 postSendViewScrolledAccessibilityEventCallback();
8187 }
8188
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008189 mBackgroundSizeChanged = true;
8190
8191 final AttachInfo ai = mAttachInfo;
8192 if (ai != null) {
8193 ai.mViewScrollChanged = true;
8194 }
8195 }
8196
8197 /**
Chet Haase21cd1382010-09-01 17:42:29 -07008198 * Interface definition for a callback to be invoked when the layout bounds of a view
8199 * changes due to layout processing.
8200 */
8201 public interface OnLayoutChangeListener {
8202 /**
8203 * Called when the focus state of a view has changed.
8204 *
8205 * @param v The view whose state has changed.
8206 * @param left The new value of the view's left property.
8207 * @param top The new value of the view's top property.
8208 * @param right The new value of the view's right property.
8209 * @param bottom The new value of the view's bottom property.
8210 * @param oldLeft The previous value of the view's left property.
8211 * @param oldTop The previous value of the view's top property.
8212 * @param oldRight The previous value of the view's right property.
8213 * @param oldBottom The previous value of the view's bottom property.
8214 */
8215 void onLayoutChange(View v, int left, int top, int right, int bottom,
8216 int oldLeft, int oldTop, int oldRight, int oldBottom);
8217 }
8218
8219 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008220 * This is called during layout when the size of this view has changed. If
8221 * you were just added to the view hierarchy, you're called with the old
8222 * values of 0.
8223 *
8224 * @param w Current width of this view.
8225 * @param h Current height of this view.
8226 * @param oldw Old width of this view.
8227 * @param oldh Old height of this view.
8228 */
8229 protected void onSizeChanged(int w, int h, int oldw, int oldh) {
8230 }
8231
8232 /**
8233 * Called by draw to draw the child views. This may be overridden
8234 * by derived classes to gain control just before its children are drawn
8235 * (but after its own view has been drawn).
8236 * @param canvas the canvas on which to draw the view
8237 */
8238 protected void dispatchDraw(Canvas canvas) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07008239
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008240 }
8241
8242 /**
8243 * Gets the parent of this view. Note that the parent is a
8244 * ViewParent and not necessarily a View.
8245 *
8246 * @return Parent of this view.
8247 */
8248 public final ViewParent getParent() {
8249 return mParent;
8250 }
8251
8252 /**
Chet Haasecca2c982011-05-20 14:34:18 -07008253 * Set the horizontal scrolled position of your view. This will cause a call to
8254 * {@link #onScrollChanged(int, int, int, int)} and the view will be
8255 * invalidated.
8256 * @param value the x position to scroll to
8257 */
8258 public void setScrollX(int value) {
8259 scrollTo(value, mScrollY);
8260 }
8261
8262 /**
8263 * Set the vertical scrolled position of your view. This will cause a call to
8264 * {@link #onScrollChanged(int, int, int, int)} and the view will be
8265 * invalidated.
8266 * @param value the y position to scroll to
8267 */
8268 public void setScrollY(int value) {
8269 scrollTo(mScrollX, value);
8270 }
8271
8272 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008273 * Return the scrolled left position of this view. This is the left edge of
8274 * the displayed part of your view. You do not need to draw any pixels
8275 * farther left, since those are outside of the frame of your view on
8276 * screen.
8277 *
8278 * @return The left edge of the displayed part of your view, in pixels.
8279 */
8280 public final int getScrollX() {
8281 return mScrollX;
8282 }
8283
8284 /**
8285 * Return the scrolled top position of this view. This is the top edge of
8286 * the displayed part of your view. You do not need to draw any pixels above
8287 * it, since those are outside of the frame of your view on screen.
8288 *
8289 * @return The top edge of the displayed part of your view, in pixels.
8290 */
8291 public final int getScrollY() {
8292 return mScrollY;
8293 }
8294
8295 /**
8296 * Return the width of the your view.
8297 *
8298 * @return The width of your view, in pixels.
8299 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07008300 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008301 public final int getWidth() {
8302 return mRight - mLeft;
8303 }
8304
8305 /**
8306 * Return the height of your view.
8307 *
8308 * @return The height of your view, in pixels.
8309 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07008310 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008311 public final int getHeight() {
8312 return mBottom - mTop;
8313 }
8314
8315 /**
8316 * Return the visible drawing bounds of your view. Fills in the output
8317 * rectangle with the values from getScrollX(), getScrollY(),
8318 * getWidth(), and getHeight().
8319 *
8320 * @param outRect The (scrolled) drawing bounds of the view.
8321 */
8322 public void getDrawingRect(Rect outRect) {
8323 outRect.left = mScrollX;
8324 outRect.top = mScrollY;
8325 outRect.right = mScrollX + (mRight - mLeft);
8326 outRect.bottom = mScrollY + (mBottom - mTop);
8327 }
8328
8329 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08008330 * Like {@link #getMeasuredWidthAndState()}, but only returns the
8331 * raw width component (that is the result is masked by
8332 * {@link #MEASURED_SIZE_MASK}).
8333 *
8334 * @return The raw measured width of this view.
8335 */
8336 public final int getMeasuredWidth() {
8337 return mMeasuredWidth & MEASURED_SIZE_MASK;
8338 }
8339
8340 /**
8341 * Return the full width measurement information for this view as computed
Romain Guy5c22a8c2011-05-13 11:48:45 -07008342 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask
Dianne Hackborn189ee182010-12-02 21:48:53 -08008343 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008344 * This should be used during measurement and layout calculations only. Use
8345 * {@link #getWidth()} to see how wide a view is after layout.
8346 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08008347 * @return The measured width of this view as a bit mask.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008348 */
Dianne Hackborn189ee182010-12-02 21:48:53 -08008349 public final int getMeasuredWidthAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008350 return mMeasuredWidth;
8351 }
8352
8353 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08008354 * Like {@link #getMeasuredHeightAndState()}, but only returns the
8355 * raw width component (that is the result is masked by
8356 * {@link #MEASURED_SIZE_MASK}).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008357 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08008358 * @return The raw measured height of this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008359 */
8360 public final int getMeasuredHeight() {
Dianne Hackborn189ee182010-12-02 21:48:53 -08008361 return mMeasuredHeight & MEASURED_SIZE_MASK;
8362 }
8363
8364 /**
8365 * Return the full height measurement information for this view as computed
Romain Guy5c22a8c2011-05-13 11:48:45 -07008366 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask
Dianne Hackborn189ee182010-12-02 21:48:53 -08008367 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
8368 * This should be used during measurement and layout calculations only. Use
8369 * {@link #getHeight()} to see how wide a view is after layout.
8370 *
8371 * @return The measured width of this view as a bit mask.
8372 */
8373 public final int getMeasuredHeightAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008374 return mMeasuredHeight;
8375 }
8376
8377 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08008378 * Return only the state bits of {@link #getMeasuredWidthAndState()}
8379 * and {@link #getMeasuredHeightAndState()}, combined into one integer.
8380 * The width component is in the regular bits {@link #MEASURED_STATE_MASK}
8381 * and the height component is at the shifted bits
8382 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}.
8383 */
8384 public final int getMeasuredState() {
8385 return (mMeasuredWidth&MEASURED_STATE_MASK)
8386 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT)
8387 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT));
8388 }
8389
8390 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07008391 * The transform matrix of this view, which is calculated based on the current
8392 * roation, scale, and pivot properties.
8393 *
8394 * @see #getRotation()
8395 * @see #getScaleX()
8396 * @see #getScaleY()
8397 * @see #getPivotX()
8398 * @see #getPivotY()
8399 * @return The current transform matrix for the view
8400 */
8401 public Matrix getMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008402 if (mTransformationInfo != null) {
8403 updateMatrix();
8404 return mTransformationInfo.mMatrix;
8405 }
8406 return Matrix.IDENTITY_MATRIX;
Romain Guy33e72ae2010-07-17 12:40:29 -07008407 }
8408
8409 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07008410 * Utility function to determine if the value is far enough away from zero to be
8411 * considered non-zero.
8412 * @param value A floating point value to check for zero-ness
8413 * @return whether the passed-in value is far enough away from zero to be considered non-zero
8414 */
8415 private static boolean nonzero(float value) {
8416 return (value < -NONZERO_EPSILON || value > NONZERO_EPSILON);
8417 }
8418
8419 /**
Jeff Brown86671742010-09-30 20:00:15 -07008420 * Returns true if the transform matrix is the identity matrix.
8421 * Recomputes the matrix if necessary.
Joe Malin32736f02011-01-19 16:14:20 -08008422 *
Romain Guy33e72ae2010-07-17 12:40:29 -07008423 * @return True if the transform matrix is the identity matrix, false otherwise.
8424 */
Jeff Brown86671742010-09-30 20:00:15 -07008425 final boolean hasIdentityMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008426 if (mTransformationInfo != null) {
8427 updateMatrix();
8428 return mTransformationInfo.mMatrixIsIdentity;
8429 }
8430 return true;
8431 }
8432
8433 void ensureTransformationInfo() {
8434 if (mTransformationInfo == null) {
8435 mTransformationInfo = new TransformationInfo();
8436 }
Jeff Brown86671742010-09-30 20:00:15 -07008437 }
8438
8439 /**
8440 * Recomputes the transform matrix if necessary.
8441 */
Romain Guy2fe9a8f2010-10-04 20:17:01 -07008442 private void updateMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008443 final TransformationInfo info = mTransformationInfo;
8444 if (info == null) {
8445 return;
8446 }
8447 if (info.mMatrixDirty) {
Chet Haasec3aa3612010-06-17 08:50:37 -07008448 // transform-related properties have changed since the last time someone
8449 // asked for the matrix; recalculate it with the current values
Chet Haasefd2b0022010-08-06 13:08:56 -07008450
8451 // Figure out if we need to update the pivot point
8452 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008453 if ((mRight - mLeft) != info.mPrevWidth || (mBottom - mTop) != info.mPrevHeight) {
8454 info.mPrevWidth = mRight - mLeft;
8455 info.mPrevHeight = mBottom - mTop;
8456 info.mPivotX = info.mPrevWidth / 2f;
8457 info.mPivotY = info.mPrevHeight / 2f;
Chet Haasefd2b0022010-08-06 13:08:56 -07008458 }
8459 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008460 info.mMatrix.reset();
8461 if (!nonzero(info.mRotationX) && !nonzero(info.mRotationY)) {
8462 info.mMatrix.setTranslate(info.mTranslationX, info.mTranslationY);
8463 info.mMatrix.preRotate(info.mRotation, info.mPivotX, info.mPivotY);
8464 info.mMatrix.preScale(info.mScaleX, info.mScaleY, info.mPivotX, info.mPivotY);
Chet Haase897247b2010-09-09 14:54:47 -07008465 } else {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008466 if (info.mCamera == null) {
8467 info.mCamera = new Camera();
8468 info.matrix3D = new Matrix();
Chet Haasefd2b0022010-08-06 13:08:56 -07008469 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008470 info.mCamera.save();
8471 info.mMatrix.preScale(info.mScaleX, info.mScaleY, info.mPivotX, info.mPivotY);
8472 info.mCamera.rotate(info.mRotationX, info.mRotationY, -info.mRotation);
8473 info.mCamera.getMatrix(info.matrix3D);
8474 info.matrix3D.preTranslate(-info.mPivotX, -info.mPivotY);
8475 info.matrix3D.postTranslate(info.mPivotX + info.mTranslationX,
8476 info.mPivotY + info.mTranslationY);
8477 info.mMatrix.postConcat(info.matrix3D);
8478 info.mCamera.restore();
Chet Haasefd2b0022010-08-06 13:08:56 -07008479 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008480 info.mMatrixDirty = false;
8481 info.mMatrixIsIdentity = info.mMatrix.isIdentity();
8482 info.mInverseMatrixDirty = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07008483 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008484 }
8485
8486 /**
8487 * Utility method to retrieve the inverse of the current mMatrix property.
8488 * We cache the matrix to avoid recalculating it when transform properties
8489 * have not changed.
8490 *
8491 * @return The inverse of the current matrix of this view.
8492 */
Jeff Brown86671742010-09-30 20:00:15 -07008493 final Matrix getInverseMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008494 final TransformationInfo info = mTransformationInfo;
8495 if (info != null) {
8496 updateMatrix();
8497 if (info.mInverseMatrixDirty) {
8498 if (info.mInverseMatrix == null) {
8499 info.mInverseMatrix = new Matrix();
8500 }
8501 info.mMatrix.invert(info.mInverseMatrix);
8502 info.mInverseMatrixDirty = false;
Chet Haasec3aa3612010-06-17 08:50:37 -07008503 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008504 return info.mInverseMatrix;
Chet Haasec3aa3612010-06-17 08:50:37 -07008505 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008506 return Matrix.IDENTITY_MATRIX;
Chet Haasec3aa3612010-06-17 08:50:37 -07008507 }
8508
8509 /**
Chet Haasea1cff502012-02-21 13:43:44 -08008510 * Gets the distance along the Z axis from the camera to this view.
8511 *
8512 * @see #setCameraDistance(float)
8513 *
8514 * @return The distance along the Z axis.
8515 */
8516 public float getCameraDistance() {
8517 ensureTransformationInfo();
8518 final float dpi = mResources.getDisplayMetrics().densityDpi;
8519 final TransformationInfo info = mTransformationInfo;
8520 if (info.mCamera == null) {
8521 info.mCamera = new Camera();
8522 info.matrix3D = new Matrix();
8523 }
8524 return -(info.mCamera.getLocationZ() * dpi);
8525 }
8526
8527 /**
Romain Guya5364ee2011-02-24 14:46:04 -08008528 * <p>Sets the distance along the Z axis (orthogonal to the X/Y plane on which
8529 * views are drawn) from the camera to this view. The camera's distance
8530 * affects 3D transformations, for instance rotations around the X and Y
8531 * axis. If the rotationX or rotationY properties are changed and this view is
Philip Milne6c8ea062012-04-03 17:38:43 -07008532 * large (more than half the size of the screen), it is recommended to always
Romain Guya5364ee2011-02-24 14:46:04 -08008533 * use a camera distance that's greater than the height (X axis rotation) or
8534 * the width (Y axis rotation) of this view.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008535 *
Romain Guya5364ee2011-02-24 14:46:04 -08008536 * <p>The distance of the camera from the view plane can have an affect on the
8537 * perspective distortion of the view when it is rotated around the x or y axis.
8538 * For example, a large distance will result in a large viewing angle, and there
8539 * will not be much perspective distortion of the view as it rotates. A short
Philip Milne6c8ea062012-04-03 17:38:43 -07008540 * distance may cause much more perspective distortion upon rotation, and can
Romain Guya5364ee2011-02-24 14:46:04 -08008541 * also result in some drawing artifacts if the rotated view ends up partially
8542 * behind the camera (which is why the recommendation is to use a distance at
8543 * least as far as the size of the view, if the view is to be rotated.)</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008544 *
Romain Guya5364ee2011-02-24 14:46:04 -08008545 * <p>The distance is expressed in "depth pixels." The default distance depends
8546 * on the screen density. For instance, on a medium density display, the
8547 * default distance is 1280. On a high density display, the default distance
8548 * is 1920.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008549 *
Romain Guya5364ee2011-02-24 14:46:04 -08008550 * <p>If you want to specify a distance that leads to visually consistent
8551 * results across various densities, use the following formula:</p>
8552 * <pre>
8553 * float scale = context.getResources().getDisplayMetrics().density;
8554 * view.setCameraDistance(distance * scale);
8555 * </pre>
Philip Milne6c8ea062012-04-03 17:38:43 -07008556 *
Romain Guya5364ee2011-02-24 14:46:04 -08008557 * <p>The density scale factor of a high density display is 1.5,
8558 * and 1920 = 1280 * 1.5.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008559 *
Romain Guya5364ee2011-02-24 14:46:04 -08008560 * @param distance The distance in "depth pixels", if negative the opposite
8561 * value is used
Philip Milne6c8ea062012-04-03 17:38:43 -07008562 *
8563 * @see #setRotationX(float)
8564 * @see #setRotationY(float)
Romain Guya5364ee2011-02-24 14:46:04 -08008565 */
8566 public void setCameraDistance(float distance) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008567 invalidateViewProperty(true, false);
Romain Guya5364ee2011-02-24 14:46:04 -08008568
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008569 ensureTransformationInfo();
Romain Guya5364ee2011-02-24 14:46:04 -08008570 final float dpi = mResources.getDisplayMetrics().densityDpi;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008571 final TransformationInfo info = mTransformationInfo;
8572 if (info.mCamera == null) {
8573 info.mCamera = new Camera();
8574 info.matrix3D = new Matrix();
Romain Guya5364ee2011-02-24 14:46:04 -08008575 }
8576
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008577 info.mCamera.setLocation(0.0f, 0.0f, -Math.abs(distance) / dpi);
8578 info.mMatrixDirty = true;
Romain Guya5364ee2011-02-24 14:46:04 -08008579
Chet Haase9d1992d2012-03-13 11:03:25 -07008580 invalidateViewProperty(false, false);
Chet Haase1271e2c2012-04-20 09:54:27 -07008581 if (mDisplayList != null) {
Chet Haaseb85967b2012-03-26 14:37:51 -07008582 mDisplayList.setCameraDistance(-Math.abs(distance) / dpi);
Chet Haasea1cff502012-02-21 13:43:44 -08008583 }
Chet Haase1a3ab172012-05-11 08:41:20 -07008584 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
8585 // View was rejected last time it was drawn by its parent; this may have changed
8586 invalidateParentIfNeeded();
8587 }
Romain Guya5364ee2011-02-24 14:46:04 -08008588 }
8589
8590 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07008591 * The degrees that the view is rotated around the pivot point.
8592 *
Philip Milne6c8ea062012-04-03 17:38:43 -07008593 * @see #setRotation(float)
Chet Haasec3aa3612010-06-17 08:50:37 -07008594 * @see #getPivotX()
8595 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008596 *
Chet Haasec3aa3612010-06-17 08:50:37 -07008597 * @return The degrees of rotation.
8598 */
Chet Haasea5531132012-02-02 13:41:44 -08008599 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008600 public float getRotation() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008601 return mTransformationInfo != null ? mTransformationInfo.mRotation : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07008602 }
8603
8604 /**
Chet Haase897247b2010-09-09 14:54:47 -07008605 * Sets the degrees that the view is rotated around the pivot point. Increasing values
8606 * result in clockwise rotation.
Chet Haasec3aa3612010-06-17 08:50:37 -07008607 *
8608 * @param rotation The degrees of rotation.
Philip Milne6c8ea062012-04-03 17:38:43 -07008609 *
8610 * @see #getRotation()
Chet Haasec3aa3612010-06-17 08:50:37 -07008611 * @see #getPivotX()
8612 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008613 * @see #setRotationX(float)
8614 * @see #setRotationY(float)
Chet Haase73066682010-11-29 15:55:32 -08008615 *
8616 * @attr ref android.R.styleable#View_rotation
Chet Haasec3aa3612010-06-17 08:50:37 -07008617 */
8618 public void setRotation(float rotation) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008619 ensureTransformationInfo();
8620 final TransformationInfo info = mTransformationInfo;
8621 if (info.mRotation != rotation) {
Chet Haasec3aa3612010-06-17 08:50:37 -07008622 // Double-invalidation is necessary to capture view's old and new areas
Chet Haase9d1992d2012-03-13 11:03:25 -07008623 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008624 info.mRotation = rotation;
8625 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008626 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008627 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008628 mDisplayList.setRotation(rotation);
8629 }
Chet Haase1a3ab172012-05-11 08:41:20 -07008630 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
8631 // View was rejected last time it was drawn by its parent; this may have changed
8632 invalidateParentIfNeeded();
8633 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008634 }
8635 }
8636
8637 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07008638 * The degrees that the view is rotated around the vertical axis through the pivot point.
8639 *
8640 * @see #getPivotX()
8641 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008642 * @see #setRotationY(float)
8643 *
Chet Haasefd2b0022010-08-06 13:08:56 -07008644 * @return The degrees of Y rotation.
8645 */
Chet Haasea5531132012-02-02 13:41:44 -08008646 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasefd2b0022010-08-06 13:08:56 -07008647 public float getRotationY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008648 return mTransformationInfo != null ? mTransformationInfo.mRotationY : 0;
Chet Haasefd2b0022010-08-06 13:08:56 -07008649 }
8650
8651 /**
Chet Haase897247b2010-09-09 14:54:47 -07008652 * Sets the degrees that the view is rotated around the vertical axis through the pivot point.
8653 * Increasing values result in counter-clockwise rotation from the viewpoint of looking
8654 * down the y axis.
Philip Milne6c8ea062012-04-03 17:38:43 -07008655 *
Romain Guya5364ee2011-02-24 14:46:04 -08008656 * When rotating large views, it is recommended to adjust the camera distance
8657 * accordingly. Refer to {@link #setCameraDistance(float)} for more information.
Chet Haasefd2b0022010-08-06 13:08:56 -07008658 *
8659 * @param rotationY The degrees of Y rotation.
Philip Milne6c8ea062012-04-03 17:38:43 -07008660 *
8661 * @see #getRotationY()
Chet Haasefd2b0022010-08-06 13:08:56 -07008662 * @see #getPivotX()
8663 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08008664 * @see #setRotation(float)
Philip Milne6c8ea062012-04-03 17:38:43 -07008665 * @see #setRotationX(float)
8666 * @see #setCameraDistance(float)
Chet Haase73066682010-11-29 15:55:32 -08008667 *
8668 * @attr ref android.R.styleable#View_rotationY
Chet Haasefd2b0022010-08-06 13:08:56 -07008669 */
8670 public void setRotationY(float rotationY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008671 ensureTransformationInfo();
8672 final TransformationInfo info = mTransformationInfo;
8673 if (info.mRotationY != rotationY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008674 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008675 info.mRotationY = rotationY;
8676 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008677 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008678 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008679 mDisplayList.setRotationY(rotationY);
8680 }
Chet Haase1a3ab172012-05-11 08:41:20 -07008681 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
8682 // View was rejected last time it was drawn by its parent; this may have changed
8683 invalidateParentIfNeeded();
8684 }
Chet Haasefd2b0022010-08-06 13:08:56 -07008685 }
8686 }
8687
8688 /**
8689 * The degrees that the view is rotated around the horizontal axis through the pivot point.
8690 *
8691 * @see #getPivotX()
8692 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008693 * @see #setRotationX(float)
8694 *
Chet Haasefd2b0022010-08-06 13:08:56 -07008695 * @return The degrees of X rotation.
8696 */
Chet Haasea5531132012-02-02 13:41:44 -08008697 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasefd2b0022010-08-06 13:08:56 -07008698 public float getRotationX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008699 return mTransformationInfo != null ? mTransformationInfo.mRotationX : 0;
Chet Haasefd2b0022010-08-06 13:08:56 -07008700 }
8701
8702 /**
Chet Haase897247b2010-09-09 14:54:47 -07008703 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point.
8704 * Increasing values result in clockwise rotation from the viewpoint of looking down the
8705 * x axis.
Philip Milne6c8ea062012-04-03 17:38:43 -07008706 *
Romain Guya5364ee2011-02-24 14:46:04 -08008707 * When rotating large views, it is recommended to adjust the camera distance
8708 * accordingly. Refer to {@link #setCameraDistance(float)} for more information.
Chet Haasefd2b0022010-08-06 13:08:56 -07008709 *
8710 * @param rotationX The degrees of X rotation.
Philip Milne6c8ea062012-04-03 17:38:43 -07008711 *
8712 * @see #getRotationX()
Chet Haasefd2b0022010-08-06 13:08:56 -07008713 * @see #getPivotX()
8714 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08008715 * @see #setRotation(float)
Philip Milne6c8ea062012-04-03 17:38:43 -07008716 * @see #setRotationY(float)
8717 * @see #setCameraDistance(float)
Chet Haase73066682010-11-29 15:55:32 -08008718 *
8719 * @attr ref android.R.styleable#View_rotationX
Chet Haasefd2b0022010-08-06 13:08:56 -07008720 */
8721 public void setRotationX(float rotationX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008722 ensureTransformationInfo();
8723 final TransformationInfo info = mTransformationInfo;
8724 if (info.mRotationX != rotationX) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008725 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008726 info.mRotationX = rotationX;
8727 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008728 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008729 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008730 mDisplayList.setRotationX(rotationX);
8731 }
Chet Haase1a3ab172012-05-11 08:41:20 -07008732 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
8733 // View was rejected last time it was drawn by its parent; this may have changed
8734 invalidateParentIfNeeded();
8735 }
Chet Haasefd2b0022010-08-06 13:08:56 -07008736 }
8737 }
8738
8739 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07008740 * The amount that the view is scaled in x around the pivot point, as a proportion of
8741 * the view's unscaled width. A value of 1, the default, means that no scaling is applied.
8742 *
Joe Onorato93162322010-09-16 15:42:01 -04008743 * <p>By default, this is 1.0f.
8744 *
Chet Haasec3aa3612010-06-17 08:50:37 -07008745 * @see #getPivotX()
8746 * @see #getPivotY()
8747 * @return The scaling factor.
8748 */
Chet Haasea5531132012-02-02 13:41:44 -08008749 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008750 public float getScaleX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008751 return mTransformationInfo != null ? mTransformationInfo.mScaleX : 1;
Chet Haasec3aa3612010-06-17 08:50:37 -07008752 }
8753
8754 /**
8755 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of
8756 * the view's unscaled width. A value of 1 means that no scaling is applied.
8757 *
8758 * @param scaleX The scaling factor.
8759 * @see #getPivotX()
8760 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008761 *
8762 * @attr ref android.R.styleable#View_scaleX
Chet Haasec3aa3612010-06-17 08:50:37 -07008763 */
8764 public void setScaleX(float scaleX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008765 ensureTransformationInfo();
8766 final TransformationInfo info = mTransformationInfo;
8767 if (info.mScaleX != scaleX) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008768 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008769 info.mScaleX = scaleX;
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.setScaleX(scaleX);
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 Haasec3aa3612010-06-17 08:50:37 -07008779 }
8780 }
8781
8782 /**
8783 * The amount that the view is scaled in y around the pivot point, as a proportion of
8784 * the view's unscaled height. 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 getScaleY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008794 return mTransformationInfo != null ? mTransformationInfo.mScaleY : 1;
Chet Haasec3aa3612010-06-17 08:50:37 -07008795 }
8796
8797 /**
8798 * Sets the amount that the view is scaled in Y 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 scaleY The scaling factor.
8802 * @see #getPivotX()
8803 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008804 *
8805 * @attr ref android.R.styleable#View_scaleY
Chet Haasec3aa3612010-06-17 08:50:37 -07008806 */
8807 public void setScaleY(float scaleY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008808 ensureTransformationInfo();
8809 final TransformationInfo info = mTransformationInfo;
8810 if (info.mScaleY != scaleY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008811 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008812 info.mScaleY = scaleY;
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.setScaleY(scaleY);
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 x location of the point around which the view is {@link #setRotation(float) rotated}
8827 * and {@link #setScaleX(float) scaled}.
8828 *
8829 * @see #getRotation()
8830 * @see #getScaleX()
8831 * @see #getScaleY()
8832 * @see #getPivotY()
8833 * @return The x location of the pivot point.
Philip Milne6c8ea062012-04-03 17:38:43 -07008834 *
8835 * @attr ref android.R.styleable#View_transformPivotX
Chet Haasec3aa3612010-06-17 08:50:37 -07008836 */
Chet Haasea5531132012-02-02 13:41:44 -08008837 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008838 public float getPivotX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008839 return mTransformationInfo != null ? mTransformationInfo.mPivotX : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07008840 }
8841
8842 /**
8843 * Sets the x location of the point around which the view is
8844 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}.
Chet Haasefd2b0022010-08-06 13:08:56 -07008845 * By default, the pivot point is centered on the object.
8846 * Setting this property disables this behavior and causes the view to use only the
8847 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07008848 *
8849 * @param pivotX The x location of the pivot point.
8850 * @see #getRotation()
8851 * @see #getScaleX()
8852 * @see #getScaleY()
8853 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008854 *
8855 * @attr ref android.R.styleable#View_transformPivotX
Chet Haasec3aa3612010-06-17 08:50:37 -07008856 */
8857 public void setPivotX(float pivotX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008858 ensureTransformationInfo();
Chet Haasefd2b0022010-08-06 13:08:56 -07008859 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008860 final TransformationInfo info = mTransformationInfo;
8861 if (info.mPivotX != pivotX) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008862 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008863 info.mPivotX = pivotX;
8864 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008865 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008866 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008867 mDisplayList.setPivotX(pivotX);
8868 }
Chet Haase1a3ab172012-05-11 08:41:20 -07008869 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
8870 // View was rejected last time it was drawn by its parent; this may have changed
8871 invalidateParentIfNeeded();
8872 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008873 }
8874 }
8875
8876 /**
8877 * The y location of the point around which the view is {@link #setRotation(float) rotated}
8878 * and {@link #setScaleY(float) scaled}.
8879 *
8880 * @see #getRotation()
8881 * @see #getScaleX()
8882 * @see #getScaleY()
8883 * @see #getPivotY()
8884 * @return The y location of the pivot point.
Philip Milne6c8ea062012-04-03 17:38:43 -07008885 *
8886 * @attr ref android.R.styleable#View_transformPivotY
Chet Haasec3aa3612010-06-17 08:50:37 -07008887 */
Chet Haasea5531132012-02-02 13:41:44 -08008888 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008889 public float getPivotY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008890 return mTransformationInfo != null ? mTransformationInfo.mPivotY : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07008891 }
8892
8893 /**
8894 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated}
Chet Haasefd2b0022010-08-06 13:08:56 -07008895 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object.
8896 * Setting this property disables this behavior and causes the view to use only the
8897 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07008898 *
8899 * @param pivotY The y location of the pivot point.
8900 * @see #getRotation()
8901 * @see #getScaleX()
8902 * @see #getScaleY()
8903 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008904 *
8905 * @attr ref android.R.styleable#View_transformPivotY
Chet Haasec3aa3612010-06-17 08:50:37 -07008906 */
8907 public void setPivotY(float pivotY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008908 ensureTransformationInfo();
Chet Haasefd2b0022010-08-06 13:08:56 -07008909 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008910 final TransformationInfo info = mTransformationInfo;
8911 if (info.mPivotY != pivotY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008912 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008913 info.mPivotY = pivotY;
8914 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008915 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008916 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008917 mDisplayList.setPivotY(pivotY);
8918 }
Chet Haase1a3ab172012-05-11 08:41:20 -07008919 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
8920 // View was rejected last time it was drawn by its parent; this may have changed
8921 invalidateParentIfNeeded();
8922 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008923 }
8924 }
8925
8926 /**
8927 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is
8928 * completely transparent and 1 means the view is completely opaque.
8929 *
Joe Onorato93162322010-09-16 15:42:01 -04008930 * <p>By default this is 1.0f.
Chet Haasec3aa3612010-06-17 08:50:37 -07008931 * @return The opacity of the view.
8932 */
Chet Haasea5531132012-02-02 13:41:44 -08008933 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008934 public float getAlpha() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008935 return mTransformationInfo != null ? mTransformationInfo.mAlpha : 1;
Chet Haasec3aa3612010-06-17 08:50:37 -07008936 }
8937
8938 /**
Chet Haasedb8c9a62012-03-21 18:54:18 -07008939 * Returns whether this View has content which overlaps. This function, intended to be
8940 * overridden by specific View types, is an optimization when alpha is set on a view. If
8941 * rendering overlaps in a view with alpha < 1, that view is drawn to an offscreen buffer
8942 * and then composited it into place, which can be expensive. If the view has no overlapping
8943 * rendering, the view can draw each primitive with the appropriate alpha value directly.
8944 * An example of overlapping rendering is a TextView with a background image, such as a
8945 * Button. An example of non-overlapping rendering is a TextView with no background, or
8946 * an ImageView with only the foreground image. The default implementation returns true;
8947 * subclasses should override if they have cases which can be optimized.
8948 *
8949 * @return true if the content in this view might overlap, false otherwise.
8950 */
8951 public boolean hasOverlappingRendering() {
8952 return true;
8953 }
8954
8955 /**
Romain Guy171c5922011-01-06 10:04:23 -08008956 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is
8957 * completely transparent and 1 means the view is completely opaque.</p>
Joe Malin32736f02011-01-19 16:14:20 -08008958 *
Romain Guy171c5922011-01-06 10:04:23 -08008959 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is
8960 * responsible for applying the opacity itself. Otherwise, calling this method is
8961 * equivalent to calling {@link #setLayerType(int, android.graphics.Paint)} and
Joe Malin32736f02011-01-19 16:14:20 -08008962 * setting a hardware layer.</p>
Chet Haasec3aa3612010-06-17 08:50:37 -07008963 *
Chet Haasea5531132012-02-02 13:41:44 -08008964 * <p>Note that setting alpha to a translucent value (0 < alpha < 1) may have
8965 * performance implications. It is generally best to use the alpha property sparingly and
8966 * transiently, as in the case of fading animations.</p>
8967 *
Chet Haasec3aa3612010-06-17 08:50:37 -07008968 * @param alpha The opacity of the view.
Chet Haase73066682010-11-29 15:55:32 -08008969 *
Joe Malin32736f02011-01-19 16:14:20 -08008970 * @see #setLayerType(int, android.graphics.Paint)
8971 *
Chet Haase73066682010-11-29 15:55:32 -08008972 * @attr ref android.R.styleable#View_alpha
Chet Haasec3aa3612010-06-17 08:50:37 -07008973 */
8974 public void setAlpha(float alpha) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008975 ensureTransformationInfo();
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008976 if (mTransformationInfo.mAlpha != alpha) {
8977 mTransformationInfo.mAlpha = alpha;
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008978 if (onSetAlpha((int) (alpha * 255))) {
8979 mPrivateFlags |= ALPHA_SET;
8980 // subclass is handling alpha - don't optimize rendering cache invalidation
Chet Haase9d1992d2012-03-13 11:03:25 -07008981 invalidateParentCaches();
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008982 invalidate(true);
8983 } else {
8984 mPrivateFlags &= ~ALPHA_SET;
Chet Haase9d1992d2012-03-13 11:03:25 -07008985 invalidateViewProperty(true, false);
Chet Haase1271e2c2012-04-20 09:54:27 -07008986 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008987 mDisplayList.setAlpha(alpha);
8988 }
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008989 }
Chet Haaseed032702010-10-01 14:05:54 -07008990 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008991 }
8992
8993 /**
Chet Haasea00f3862011-02-22 06:34:40 -08008994 * Faster version of setAlpha() which performs the same steps except there are
8995 * no calls to invalidate(). The caller of this function should perform proper invalidation
8996 * on the parent and this object. The return value indicates whether the subclass handles
8997 * alpha (the return value for onSetAlpha()).
8998 *
8999 * @param alpha The new value for the alpha property
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009000 * @return true if the View subclass handles alpha (the return value for onSetAlpha()) and
9001 * the new value for the alpha property is different from the old value
Chet Haasea00f3862011-02-22 06:34:40 -08009002 */
9003 boolean setAlphaNoInvalidation(float alpha) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009004 ensureTransformationInfo();
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009005 if (mTransformationInfo.mAlpha != alpha) {
9006 mTransformationInfo.mAlpha = alpha;
9007 boolean subclassHandlesAlpha = onSetAlpha((int) (alpha * 255));
9008 if (subclassHandlesAlpha) {
9009 mPrivateFlags |= ALPHA_SET;
9010 return true;
9011 } else {
9012 mPrivateFlags &= ~ALPHA_SET;
Chet Haase1271e2c2012-04-20 09:54:27 -07009013 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009014 mDisplayList.setAlpha(alpha);
9015 }
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009016 }
Chet Haasea00f3862011-02-22 06:34:40 -08009017 }
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009018 return false;
Chet Haasea00f3862011-02-22 06:34:40 -08009019 }
9020
9021 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009022 * Top position of this view relative to its parent.
9023 *
9024 * @return The top of this view, in pixels.
9025 */
9026 @ViewDebug.CapturedViewProperty
9027 public final int getTop() {
9028 return mTop;
9029 }
9030
9031 /**
Chet Haase21cd1382010-09-01 17:42:29 -07009032 * Sets the top position of this view relative to its parent. This method is meant to be called
9033 * by the layout system and should not generally be called otherwise, because the property
9034 * may be changed at any time by the layout.
9035 *
9036 * @param top The top of this view, in pixels.
9037 */
9038 public final void setTop(int top) {
9039 if (top != mTop) {
Jeff Brown86671742010-09-30 20:00:15 -07009040 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009041 final boolean matrixIsIdentity = mTransformationInfo == null
9042 || mTransformationInfo.mMatrixIsIdentity;
9043 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08009044 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07009045 int minTop;
9046 int yLoc;
9047 if (top < mTop) {
9048 minTop = top;
9049 yLoc = top - mTop;
9050 } else {
9051 minTop = mTop;
9052 yLoc = 0;
9053 }
Chet Haasee9140a72011-02-16 16:23:29 -08009054 invalidate(0, yLoc, mRight - mLeft, mBottom - minTop);
Chet Haase21cd1382010-09-01 17:42:29 -07009055 }
9056 } else {
9057 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009058 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009059 }
9060
Chet Haaseed032702010-10-01 14:05:54 -07009061 int width = mRight - mLeft;
9062 int oldHeight = mBottom - mTop;
9063
Chet Haase21cd1382010-09-01 17:42:29 -07009064 mTop = top;
Chet Haase1271e2c2012-04-20 09:54:27 -07009065 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009066 mDisplayList.setTop(mTop);
9067 }
Chet Haase21cd1382010-09-01 17:42:29 -07009068
Chet Haaseed032702010-10-01 14:05:54 -07009069 onSizeChanged(width, mBottom - mTop, width, oldHeight);
9070
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009071 if (!matrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009072 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9073 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009074 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009075 }
Chet Haase21cd1382010-09-01 17:42:29 -07009076 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009077 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009078 }
Chet Haase55dbb652010-12-21 20:15:08 -08009079 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009080 invalidateParentIfNeeded();
Chet Haase1a3ab172012-05-11 08:41:20 -07009081 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
9082 // View was rejected last time it was drawn by its parent; this may have changed
9083 invalidateParentIfNeeded();
9084 }
Chet Haase21cd1382010-09-01 17:42:29 -07009085 }
9086 }
9087
9088 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009089 * Bottom position of this view relative to its parent.
9090 *
9091 * @return The bottom of this view, in pixels.
9092 */
9093 @ViewDebug.CapturedViewProperty
9094 public final int getBottom() {
9095 return mBottom;
9096 }
9097
9098 /**
Michael Jurkadab559a2011-01-04 20:31:51 -08009099 * True if this view has changed since the last time being drawn.
9100 *
9101 * @return The dirty state of this view.
9102 */
9103 public boolean isDirty() {
9104 return (mPrivateFlags & DIRTY_MASK) != 0;
9105 }
9106
9107 /**
Chet Haase21cd1382010-09-01 17:42:29 -07009108 * Sets the bottom position of this view relative to its parent. This method is meant to be
9109 * called by the layout system and should not generally be called otherwise, because the
9110 * property may be changed at any time by the layout.
9111 *
9112 * @param bottom The bottom of this view, in pixels.
9113 */
9114 public final void setBottom(int bottom) {
9115 if (bottom != mBottom) {
Jeff Brown86671742010-09-30 20:00:15 -07009116 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009117 final boolean matrixIsIdentity = mTransformationInfo == null
9118 || mTransformationInfo.mMatrixIsIdentity;
9119 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08009120 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07009121 int maxBottom;
9122 if (bottom < mBottom) {
9123 maxBottom = mBottom;
9124 } else {
9125 maxBottom = bottom;
9126 }
Chet Haasee9140a72011-02-16 16:23:29 -08009127 invalidate(0, 0, mRight - mLeft, maxBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07009128 }
9129 } else {
9130 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009131 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009132 }
9133
Chet Haaseed032702010-10-01 14:05:54 -07009134 int width = mRight - mLeft;
9135 int oldHeight = mBottom - mTop;
9136
Chet Haase21cd1382010-09-01 17:42:29 -07009137 mBottom = bottom;
Chet Haase1271e2c2012-04-20 09:54:27 -07009138 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009139 mDisplayList.setBottom(mBottom);
9140 }
Chet Haase21cd1382010-09-01 17:42:29 -07009141
Chet Haaseed032702010-10-01 14:05:54 -07009142 onSizeChanged(width, mBottom - mTop, width, oldHeight);
9143
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009144 if (!matrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009145 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9146 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009147 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009148 }
Chet Haase21cd1382010-09-01 17:42:29 -07009149 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009150 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009151 }
Chet Haase55dbb652010-12-21 20:15:08 -08009152 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009153 invalidateParentIfNeeded();
Chet Haase1a3ab172012-05-11 08:41:20 -07009154 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
9155 // View was rejected last time it was drawn by its parent; this may have changed
9156 invalidateParentIfNeeded();
9157 }
Chet Haase21cd1382010-09-01 17:42:29 -07009158 }
9159 }
9160
9161 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009162 * Left position of this view relative to its parent.
9163 *
9164 * @return The left edge of this view, in pixels.
9165 */
9166 @ViewDebug.CapturedViewProperty
9167 public final int getLeft() {
9168 return mLeft;
9169 }
9170
9171 /**
Chet Haase21cd1382010-09-01 17:42:29 -07009172 * Sets the left position of this view relative to its parent. This method is meant to be called
9173 * by the layout system and should not generally be called otherwise, because the property
9174 * may be changed at any time by the layout.
9175 *
9176 * @param left The bottom of this view, in pixels.
9177 */
9178 public final void setLeft(int left) {
9179 if (left != mLeft) {
Jeff Brown86671742010-09-30 20:00:15 -07009180 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009181 final boolean matrixIsIdentity = mTransformationInfo == null
9182 || mTransformationInfo.mMatrixIsIdentity;
9183 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08009184 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07009185 int minLeft;
9186 int xLoc;
9187 if (left < mLeft) {
9188 minLeft = left;
9189 xLoc = left - mLeft;
9190 } else {
9191 minLeft = mLeft;
9192 xLoc = 0;
9193 }
Chet Haasee9140a72011-02-16 16:23:29 -08009194 invalidate(xLoc, 0, mRight - minLeft, mBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07009195 }
9196 } else {
9197 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009198 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009199 }
9200
Chet Haaseed032702010-10-01 14:05:54 -07009201 int oldWidth = mRight - mLeft;
9202 int height = mBottom - mTop;
9203
Chet Haase21cd1382010-09-01 17:42:29 -07009204 mLeft = left;
Chet Haase1271e2c2012-04-20 09:54:27 -07009205 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009206 mDisplayList.setLeft(left);
9207 }
Chet Haase21cd1382010-09-01 17:42:29 -07009208
Chet Haaseed032702010-10-01 14:05:54 -07009209 onSizeChanged(mRight - mLeft, height, oldWidth, height);
9210
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009211 if (!matrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009212 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9213 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009214 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009215 }
Chet Haase21cd1382010-09-01 17:42:29 -07009216 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009217 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009218 }
Chet Haase55dbb652010-12-21 20:15:08 -08009219 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009220 invalidateParentIfNeeded();
Chet Haase1a3ab172012-05-11 08:41:20 -07009221 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
9222 // View was rejected last time it was drawn by its parent; this may have changed
9223 invalidateParentIfNeeded();
9224 }
Chet Haase21cd1382010-09-01 17:42:29 -07009225 }
9226 }
9227
9228 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009229 * Right position of this view relative to its parent.
9230 *
9231 * @return The right edge of this view, in pixels.
9232 */
9233 @ViewDebug.CapturedViewProperty
9234 public final int getRight() {
9235 return mRight;
9236 }
9237
9238 /**
Chet Haase21cd1382010-09-01 17:42:29 -07009239 * Sets the right position of this view relative to its parent. This method is meant to be called
9240 * by the layout system and should not generally be called otherwise, because the property
9241 * may be changed at any time by the layout.
9242 *
9243 * @param right The bottom of this view, in pixels.
9244 */
9245 public final void setRight(int right) {
9246 if (right != mRight) {
Jeff Brown86671742010-09-30 20:00:15 -07009247 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009248 final boolean matrixIsIdentity = mTransformationInfo == null
9249 || mTransformationInfo.mMatrixIsIdentity;
9250 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08009251 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07009252 int maxRight;
9253 if (right < mRight) {
9254 maxRight = mRight;
9255 } else {
9256 maxRight = right;
9257 }
Chet Haasee9140a72011-02-16 16:23:29 -08009258 invalidate(0, 0, maxRight - mLeft, mBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07009259 }
9260 } else {
9261 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009262 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009263 }
9264
Chet Haaseed032702010-10-01 14:05:54 -07009265 int oldWidth = mRight - mLeft;
9266 int height = mBottom - mTop;
9267
Chet Haase21cd1382010-09-01 17:42:29 -07009268 mRight = right;
Chet Haase1271e2c2012-04-20 09:54:27 -07009269 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009270 mDisplayList.setRight(mRight);
9271 }
Chet Haase21cd1382010-09-01 17:42:29 -07009272
Chet Haaseed032702010-10-01 14:05:54 -07009273 onSizeChanged(mRight - mLeft, height, oldWidth, height);
9274
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009275 if (!matrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009276 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9277 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009278 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009279 }
Chet Haase21cd1382010-09-01 17:42:29 -07009280 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009281 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009282 }
Chet Haase55dbb652010-12-21 20:15:08 -08009283 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009284 invalidateParentIfNeeded();
Chet Haase1a3ab172012-05-11 08:41:20 -07009285 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
9286 // View was rejected last time it was drawn by its parent; this may have changed
9287 invalidateParentIfNeeded();
9288 }
Chet Haase21cd1382010-09-01 17:42:29 -07009289 }
9290 }
9291
9292 /**
Chet Haasedf030d22010-07-30 17:22:38 -07009293 * The visual x position of this view, in pixels. This is equivalent to the
9294 * {@link #setTranslationX(float) translationX} property plus the current
Joe Malin32736f02011-01-19 16:14:20 -08009295 * {@link #getLeft() left} property.
Chet Haasec3aa3612010-06-17 08:50:37 -07009296 *
Chet Haasedf030d22010-07-30 17:22:38 -07009297 * @return The visual x position of this view, in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07009298 */
Chet Haasea5531132012-02-02 13:41:44 -08009299 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009300 public float getX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009301 return mLeft + (mTransformationInfo != null ? mTransformationInfo.mTranslationX : 0);
Chet Haasedf030d22010-07-30 17:22:38 -07009302 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009303
Chet Haasedf030d22010-07-30 17:22:38 -07009304 /**
9305 * Sets the visual x position of this view, in pixels. This is equivalent to setting the
9306 * {@link #setTranslationX(float) translationX} property to be the difference between
9307 * the x value passed in and the current {@link #getLeft() left} property.
9308 *
9309 * @param x The visual x position of this view, in pixels.
9310 */
9311 public void setX(float x) {
9312 setTranslationX(x - mLeft);
9313 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009314
Chet Haasedf030d22010-07-30 17:22:38 -07009315 /**
9316 * The visual y position of this view, in pixels. This is equivalent to the
9317 * {@link #setTranslationY(float) translationY} property plus the current
9318 * {@link #getTop() top} property.
9319 *
9320 * @return The visual y position of this view, in pixels.
9321 */
Chet Haasea5531132012-02-02 13:41:44 -08009322 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009323 public float getY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009324 return mTop + (mTransformationInfo != null ? mTransformationInfo.mTranslationY : 0);
Chet Haasedf030d22010-07-30 17:22:38 -07009325 }
9326
9327 /**
9328 * Sets the visual y position of this view, in pixels. This is equivalent to setting the
9329 * {@link #setTranslationY(float) translationY} property to be the difference between
9330 * the y value passed in and the current {@link #getTop() top} property.
9331 *
9332 * @param y The visual y position of this view, in pixels.
9333 */
9334 public void setY(float y) {
9335 setTranslationY(y - mTop);
9336 }
9337
9338
9339 /**
9340 * The horizontal location of this view relative to its {@link #getLeft() left} position.
9341 * This position is post-layout, in addition to wherever the object's
9342 * layout placed it.
9343 *
9344 * @return The horizontal position of this view relative to its left position, in pixels.
9345 */
Chet Haasea5531132012-02-02 13:41:44 -08009346 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009347 public float getTranslationX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009348 return mTransformationInfo != null ? mTransformationInfo.mTranslationX : 0;
Chet Haasedf030d22010-07-30 17:22:38 -07009349 }
9350
9351 /**
9352 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position.
9353 * This effectively positions the object post-layout, in addition to wherever the object's
9354 * layout placed it.
9355 *
9356 * @param translationX The horizontal position of this view relative to its left position,
9357 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08009358 *
9359 * @attr ref android.R.styleable#View_translationX
Chet Haasedf030d22010-07-30 17:22:38 -07009360 */
9361 public void setTranslationX(float translationX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009362 ensureTransformationInfo();
9363 final TransformationInfo info = mTransformationInfo;
9364 if (info.mTranslationX != translationX) {
Chet Haasedf030d22010-07-30 17:22:38 -07009365 // Double-invalidation is necessary to capture view's old and new areas
Chet Haase9d1992d2012-03-13 11:03:25 -07009366 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009367 info.mTranslationX = translationX;
9368 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07009369 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07009370 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009371 mDisplayList.setTranslationX(translationX);
9372 }
Chet Haase1a3ab172012-05-11 08:41:20 -07009373 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
9374 // View was rejected last time it was drawn by its parent; this may have changed
9375 invalidateParentIfNeeded();
9376 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009377 }
9378 }
9379
9380 /**
Chet Haasedf030d22010-07-30 17:22:38 -07009381 * The horizontal location of this view relative to its {@link #getTop() top} position.
9382 * This position is post-layout, in addition to wherever the object's
9383 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07009384 *
Chet Haasedf030d22010-07-30 17:22:38 -07009385 * @return The vertical position of this view relative to its top position,
9386 * in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07009387 */
Chet Haasea5531132012-02-02 13:41:44 -08009388 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009389 public float getTranslationY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009390 return mTransformationInfo != null ? mTransformationInfo.mTranslationY : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07009391 }
9392
9393 /**
Chet Haasedf030d22010-07-30 17:22:38 -07009394 * Sets the vertical location of this view relative to its {@link #getTop() top} position.
9395 * This effectively positions the object post-layout, in addition to wherever the object's
9396 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07009397 *
Chet Haasedf030d22010-07-30 17:22:38 -07009398 * @param translationY The vertical position of this view relative to its top position,
9399 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08009400 *
9401 * @attr ref android.R.styleable#View_translationY
Chet Haasec3aa3612010-06-17 08:50:37 -07009402 */
Chet Haasedf030d22010-07-30 17:22:38 -07009403 public void setTranslationY(float translationY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009404 ensureTransformationInfo();
9405 final TransformationInfo info = mTransformationInfo;
9406 if (info.mTranslationY != translationY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009407 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009408 info.mTranslationY = translationY;
9409 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07009410 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07009411 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009412 mDisplayList.setTranslationY(translationY);
9413 }
Chet Haase1a3ab172012-05-11 08:41:20 -07009414 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
9415 // View was rejected last time it was drawn by its parent; this may have changed
9416 invalidateParentIfNeeded();
9417 }
Chet Haasedf030d22010-07-30 17:22:38 -07009418 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009419 }
9420
9421 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009422 * Hit rectangle in parent's coordinates
9423 *
9424 * @param outRect The hit rectangle of the view.
9425 */
9426 public void getHitRect(Rect outRect) {
Jeff Brown86671742010-09-30 20:00:15 -07009427 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009428 final TransformationInfo info = mTransformationInfo;
9429 if (info == null || info.mMatrixIsIdentity || mAttachInfo == null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07009430 outRect.set(mLeft, mTop, mRight, mBottom);
9431 } else {
9432 final RectF tmpRect = mAttachInfo.mTmpTransformRect;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009433 tmpRect.set(-info.mPivotX, -info.mPivotY,
9434 getWidth() - info.mPivotX, getHeight() - info.mPivotY);
9435 info.mMatrix.mapRect(tmpRect);
Romain Guy33e72ae2010-07-17 12:40:29 -07009436 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop,
9437 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop);
Chet Haasec3aa3612010-06-17 08:50:37 -07009438 }
9439 }
9440
9441 /**
Jeff Brown20e987b2010-08-23 12:01:02 -07009442 * Determines whether the given point, in local coordinates is inside the view.
9443 */
9444 /*package*/ final boolean pointInView(float localX, float localY) {
9445 return localX >= 0 && localX < (mRight - mLeft)
9446 && localY >= 0 && localY < (mBottom - mTop);
9447 }
9448
9449 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07009450 * Utility method to determine whether the given point, in local coordinates,
9451 * is inside the view, where the area of the view is expanded by the slop factor.
9452 * This method is called while processing touch-move events to determine if the event
9453 * is still within the view.
9454 */
9455 private boolean pointInView(float localX, float localY, float slop) {
Jeff Brown20e987b2010-08-23 12:01:02 -07009456 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) &&
Romain Guy33e72ae2010-07-17 12:40:29 -07009457 localY < ((mBottom - mTop) + slop);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009458 }
9459
9460 /**
9461 * When a view has focus and the user navigates away from it, the next view is searched for
9462 * starting from the rectangle filled in by this method.
9463 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07009464 * By default, the rectange is the {@link #getDrawingRect(android.graphics.Rect)})
9465 * of the view. However, if your view maintains some idea of internal selection,
9466 * such as a cursor, or a selected row or column, you should override this method and
9467 * fill in a more specific rectangle.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009468 *
9469 * @param r The rectangle to fill in, in this view's coordinates.
9470 */
9471 public void getFocusedRect(Rect r) {
9472 getDrawingRect(r);
9473 }
9474
9475 /**
9476 * If some part of this view is not clipped by any of its parents, then
9477 * return that area in r in global (root) coordinates. To convert r to local
Gilles Debunnecea45132011-11-24 02:19:27 +01009478 * coordinates (without taking possible View rotations into account), offset
9479 * it by -globalOffset (e.g. r.offset(-globalOffset.x, -globalOffset.y)).
9480 * If the view is completely clipped or translated out, return false.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009481 *
9482 * @param r If true is returned, r holds the global coordinates of the
9483 * visible portion of this view.
9484 * @param globalOffset If true is returned, globalOffset holds the dx,dy
9485 * between this view and its root. globalOffet may be null.
9486 * @return true if r is non-empty (i.e. part of the view is visible at the
9487 * root level.
9488 */
9489 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) {
9490 int width = mRight - mLeft;
9491 int height = mBottom - mTop;
9492 if (width > 0 && height > 0) {
9493 r.set(0, 0, width, height);
9494 if (globalOffset != null) {
9495 globalOffset.set(-mScrollX, -mScrollY);
9496 }
9497 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset);
9498 }
9499 return false;
9500 }
9501
9502 public final boolean getGlobalVisibleRect(Rect r) {
9503 return getGlobalVisibleRect(r, null);
9504 }
9505
9506 public final boolean getLocalVisibleRect(Rect r) {
Romain Guyab4c4f4f2012-05-06 13:11:24 -07009507 final Point offset = mAttachInfo != null ? mAttachInfo.mPoint : new Point();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009508 if (getGlobalVisibleRect(r, offset)) {
9509 r.offset(-offset.x, -offset.y); // make r local
9510 return true;
9511 }
9512 return false;
9513 }
9514
9515 /**
9516 * Offset this view's vertical location by the specified number of pixels.
9517 *
9518 * @param offset the number of pixels to offset the view by
9519 */
9520 public void offsetTopAndBottom(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07009521 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07009522 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009523 final boolean matrixIsIdentity = mTransformationInfo == null
9524 || mTransformationInfo.mMatrixIsIdentity;
9525 if (matrixIsIdentity) {
Chet Haase1271e2c2012-04-20 09:54:27 -07009526 if (mDisplayList != null) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009527 invalidateViewProperty(false, false);
9528 } else {
9529 final ViewParent p = mParent;
9530 if (p != null && mAttachInfo != null) {
9531 final Rect r = mAttachInfo.mTmpInvalRect;
9532 int minTop;
9533 int maxBottom;
9534 int yLoc;
9535 if (offset < 0) {
9536 minTop = mTop + offset;
9537 maxBottom = mBottom;
9538 yLoc = offset;
9539 } else {
9540 minTop = mTop;
9541 maxBottom = mBottom + offset;
9542 yLoc = 0;
9543 }
9544 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop);
9545 p.invalidateChild(this, r);
Chet Haase8fbf8d22010-07-30 15:01:32 -07009546 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009547 }
9548 } else {
Chet Haase9d1992d2012-03-13 11:03:25 -07009549 invalidateViewProperty(false, false);
Chet Haasec3aa3612010-06-17 08:50:37 -07009550 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009551
Chet Haasec3aa3612010-06-17 08:50:37 -07009552 mTop += offset;
9553 mBottom += offset;
Chet Haase1271e2c2012-04-20 09:54:27 -07009554 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009555 mDisplayList.offsetTopBottom(offset);
Chet Haase9d1992d2012-03-13 11:03:25 -07009556 invalidateViewProperty(false, false);
9557 } else {
9558 if (!matrixIsIdentity) {
9559 invalidateViewProperty(false, true);
9560 }
9561 invalidateParentIfNeeded();
Chet Haasea1cff502012-02-21 13:43:44 -08009562 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009563 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009564 }
9565
9566 /**
9567 * Offset this view's horizontal location by the specified amount of pixels.
9568 *
9569 * @param offset the numer of pixels to offset the view by
9570 */
9571 public void offsetLeftAndRight(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07009572 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07009573 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009574 final boolean matrixIsIdentity = mTransformationInfo == null
9575 || mTransformationInfo.mMatrixIsIdentity;
9576 if (matrixIsIdentity) {
Chet Haase1271e2c2012-04-20 09:54:27 -07009577 if (mDisplayList != null) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009578 invalidateViewProperty(false, false);
9579 } else {
9580 final ViewParent p = mParent;
9581 if (p != null && mAttachInfo != null) {
9582 final Rect r = mAttachInfo.mTmpInvalRect;
9583 int minLeft;
9584 int maxRight;
9585 if (offset < 0) {
9586 minLeft = mLeft + offset;
9587 maxRight = mRight;
9588 } else {
9589 minLeft = mLeft;
9590 maxRight = mRight + offset;
9591 }
9592 r.set(0, 0, maxRight - minLeft, mBottom - mTop);
9593 p.invalidateChild(this, r);
Chet Haase8fbf8d22010-07-30 15:01:32 -07009594 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009595 }
9596 } else {
Chet Haase9d1992d2012-03-13 11:03:25 -07009597 invalidateViewProperty(false, false);
Chet Haasec3aa3612010-06-17 08:50:37 -07009598 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009599
Chet Haasec3aa3612010-06-17 08:50:37 -07009600 mLeft += offset;
9601 mRight += offset;
Chet Haase1271e2c2012-04-20 09:54:27 -07009602 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009603 mDisplayList.offsetLeftRight(offset);
Chet Haase9d1992d2012-03-13 11:03:25 -07009604 invalidateViewProperty(false, false);
9605 } else {
9606 if (!matrixIsIdentity) {
9607 invalidateViewProperty(false, true);
9608 }
9609 invalidateParentIfNeeded();
Chet Haasea1cff502012-02-21 13:43:44 -08009610 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009611 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009612 }
9613
9614 /**
9615 * Get the LayoutParams associated with this view. All views should have
9616 * layout parameters. These supply parameters to the <i>parent</i> of this
9617 * view specifying how it should be arranged. There are many subclasses of
9618 * ViewGroup.LayoutParams, and these correspond to the different subclasses
9619 * of ViewGroup that are responsible for arranging their children.
Romain Guy01c174b2011-02-22 11:51:06 -08009620 *
9621 * This method may return null if this View is not attached to a parent
9622 * ViewGroup or {@link #setLayoutParams(android.view.ViewGroup.LayoutParams)}
9623 * was not invoked successfully. When a View is attached to a parent
9624 * ViewGroup, this method must not return null.
9625 *
9626 * @return The LayoutParams associated with this view, or null if no
9627 * parameters have been set yet
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009628 */
Konstantin Lopyrev91a7f5f2010-08-10 18:54:54 -07009629 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009630 public ViewGroup.LayoutParams getLayoutParams() {
9631 return mLayoutParams;
9632 }
9633
9634 /**
9635 * Set the layout parameters associated with this view. These supply
9636 * parameters to the <i>parent</i> of this view specifying how it should be
9637 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these
9638 * correspond to the different subclasses of ViewGroup that are responsible
9639 * for arranging their children.
9640 *
Romain Guy01c174b2011-02-22 11:51:06 -08009641 * @param params The layout parameters for this view, cannot be null
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009642 */
9643 public void setLayoutParams(ViewGroup.LayoutParams params) {
9644 if (params == null) {
Romain Guy01c174b2011-02-22 11:51:06 -08009645 throw new NullPointerException("Layout parameters cannot be null");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009646 }
9647 mLayoutParams = params;
Philip Milned7dd8902012-01-26 16:55:30 -08009648 if (mParent instanceof ViewGroup) {
9649 ((ViewGroup) mParent).onSetLayoutParams(this, params);
9650 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009651 requestLayout();
9652 }
9653
9654 /**
9655 * Set the scrolled position of your view. This will cause a call to
9656 * {@link #onScrollChanged(int, int, int, int)} and the view will be
9657 * invalidated.
9658 * @param x the x position to scroll to
9659 * @param y the y position to scroll to
9660 */
9661 public void scrollTo(int x, int y) {
9662 if (mScrollX != x || mScrollY != y) {
9663 int oldX = mScrollX;
9664 int oldY = mScrollY;
9665 mScrollX = x;
9666 mScrollY = y;
Romain Guy0fd89bf2011-01-26 15:41:30 -08009667 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009668 onScrollChanged(mScrollX, mScrollY, oldX, oldY);
Mike Cleronf116bf82009-09-27 19:14:12 -07009669 if (!awakenScrollBars()) {
Adam Powelldf3ae4f2012-04-10 18:55:22 -07009670 postInvalidateOnAnimation();
Mike Cleronf116bf82009-09-27 19:14:12 -07009671 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009672 }
9673 }
9674
9675 /**
9676 * Move the scrolled position of your view. This will cause a call to
9677 * {@link #onScrollChanged(int, int, int, int)} and the view will be
9678 * invalidated.
9679 * @param x the amount of pixels to scroll by horizontally
9680 * @param y the amount of pixels to scroll by vertically
9681 */
9682 public void scrollBy(int x, int y) {
9683 scrollTo(mScrollX + x, mScrollY + y);
9684 }
9685
9686 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07009687 * <p>Trigger the scrollbars to draw. When invoked this method starts an
9688 * animation to fade the scrollbars out after a default delay. If a subclass
9689 * provides animated scrolling, the start delay should equal the duration
9690 * of the scrolling animation.</p>
9691 *
9692 * <p>The animation starts only if at least one of the scrollbars is
9693 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and
9694 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
9695 * this method returns true, and false otherwise. If the animation is
9696 * started, this method calls {@link #invalidate()}; in that case the
9697 * caller should not call {@link #invalidate()}.</p>
9698 *
9699 * <p>This method should be invoked every time a subclass directly updates
Mike Cleronfe81d382009-09-28 14:22:16 -07009700 * the scroll parameters.</p>
Mike Cleronf116bf82009-09-27 19:14:12 -07009701 *
9702 * <p>This method is automatically invoked by {@link #scrollBy(int, int)}
9703 * and {@link #scrollTo(int, int)}.</p>
9704 *
9705 * @return true if the animation is played, false otherwise
9706 *
9707 * @see #awakenScrollBars(int)
Mike Cleronf116bf82009-09-27 19:14:12 -07009708 * @see #scrollBy(int, int)
9709 * @see #scrollTo(int, int)
9710 * @see #isHorizontalScrollBarEnabled()
9711 * @see #isVerticalScrollBarEnabled()
9712 * @see #setHorizontalScrollBarEnabled(boolean)
9713 * @see #setVerticalScrollBarEnabled(boolean)
9714 */
9715 protected boolean awakenScrollBars() {
9716 return mScrollCache != null &&
Mike Cleron290947b2009-09-29 18:34:32 -07009717 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true);
Mike Cleronf116bf82009-09-27 19:14:12 -07009718 }
9719
9720 /**
Adam Powell8568c3a2010-04-19 14:26:11 -07009721 * Trigger the scrollbars to draw.
9722 * This method differs from awakenScrollBars() only in its default duration.
9723 * initialAwakenScrollBars() will show the scroll bars for longer than
9724 * usual to give the user more of a chance to notice them.
9725 *
9726 * @return true if the animation is played, false otherwise.
9727 */
9728 private boolean initialAwakenScrollBars() {
9729 return mScrollCache != null &&
9730 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true);
9731 }
9732
9733 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07009734 * <p>
9735 * Trigger the scrollbars to draw. When invoked this method starts an
9736 * animation to fade the scrollbars out after a fixed delay. If a subclass
9737 * provides animated scrolling, the start delay should equal the duration of
9738 * the scrolling animation.
9739 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009740 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009741 * <p>
9742 * The animation starts only if at least one of the scrollbars is enabled,
9743 * as specified by {@link #isHorizontalScrollBarEnabled()} and
9744 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
9745 * this method returns true, and false otherwise. If the animation is
9746 * started, this method calls {@link #invalidate()}; in that case the caller
9747 * should not call {@link #invalidate()}.
9748 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009749 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009750 * <p>
9751 * This method should be invoked everytime a subclass directly updates the
Mike Cleronfe81d382009-09-28 14:22:16 -07009752 * scroll parameters.
Mike Cleronf116bf82009-09-27 19:14:12 -07009753 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009754 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009755 * @param startDelay the delay, in milliseconds, after which the animation
9756 * should start; when the delay is 0, the animation starts
9757 * immediately
9758 * @return true if the animation is played, false otherwise
Joe Malin32736f02011-01-19 16:14:20 -08009759 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009760 * @see #scrollBy(int, int)
9761 * @see #scrollTo(int, int)
9762 * @see #isHorizontalScrollBarEnabled()
9763 * @see #isVerticalScrollBarEnabled()
9764 * @see #setHorizontalScrollBarEnabled(boolean)
9765 * @see #setVerticalScrollBarEnabled(boolean)
9766 */
9767 protected boolean awakenScrollBars(int startDelay) {
Mike Cleron290947b2009-09-29 18:34:32 -07009768 return awakenScrollBars(startDelay, true);
9769 }
Joe Malin32736f02011-01-19 16:14:20 -08009770
Mike Cleron290947b2009-09-29 18:34:32 -07009771 /**
9772 * <p>
9773 * Trigger the scrollbars to draw. When invoked this method starts an
9774 * animation to fade the scrollbars out after a fixed delay. If a subclass
9775 * provides animated scrolling, the start delay should equal the duration of
9776 * the scrolling animation.
9777 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009778 *
Mike Cleron290947b2009-09-29 18:34:32 -07009779 * <p>
9780 * The animation starts only if at least one of the scrollbars is enabled,
9781 * as specified by {@link #isHorizontalScrollBarEnabled()} and
9782 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
9783 * this method returns true, and false otherwise. If the animation is
Joe Malin32736f02011-01-19 16:14:20 -08009784 * started, this method calls {@link #invalidate()} if the invalidate parameter
Mike Cleron290947b2009-09-29 18:34:32 -07009785 * is set to true; in that case the caller
9786 * should not call {@link #invalidate()}.
9787 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009788 *
Mike Cleron290947b2009-09-29 18:34:32 -07009789 * <p>
9790 * This method should be invoked everytime a subclass directly updates the
9791 * scroll parameters.
9792 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009793 *
Mike Cleron290947b2009-09-29 18:34:32 -07009794 * @param startDelay the delay, in milliseconds, after which the animation
9795 * should start; when the delay is 0, the animation starts
9796 * immediately
Joe Malin32736f02011-01-19 16:14:20 -08009797 *
Mike Cleron290947b2009-09-29 18:34:32 -07009798 * @param invalidate Wheter this method should call invalidate
Joe Malin32736f02011-01-19 16:14:20 -08009799 *
Mike Cleron290947b2009-09-29 18:34:32 -07009800 * @return true if the animation is played, false otherwise
Joe Malin32736f02011-01-19 16:14:20 -08009801 *
Mike Cleron290947b2009-09-29 18:34:32 -07009802 * @see #scrollBy(int, int)
9803 * @see #scrollTo(int, int)
9804 * @see #isHorizontalScrollBarEnabled()
9805 * @see #isVerticalScrollBarEnabled()
9806 * @see #setHorizontalScrollBarEnabled(boolean)
9807 * @see #setVerticalScrollBarEnabled(boolean)
9808 */
9809 protected boolean awakenScrollBars(int startDelay, boolean invalidate) {
Mike Cleronf116bf82009-09-27 19:14:12 -07009810 final ScrollabilityCache scrollCache = mScrollCache;
Joe Malin32736f02011-01-19 16:14:20 -08009811
Mike Cleronf116bf82009-09-27 19:14:12 -07009812 if (scrollCache == null || !scrollCache.fadeScrollBars) {
9813 return false;
9814 }
9815
9816 if (scrollCache.scrollBar == null) {
9817 scrollCache.scrollBar = new ScrollBarDrawable();
9818 }
9819
9820 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) {
9821
Mike Cleron290947b2009-09-29 18:34:32 -07009822 if (invalidate) {
9823 // Invalidate to show the scrollbars
Adam Powelldf3ae4f2012-04-10 18:55:22 -07009824 postInvalidateOnAnimation();
Mike Cleron290947b2009-09-29 18:34:32 -07009825 }
Mike Cleronf116bf82009-09-27 19:14:12 -07009826
9827 if (scrollCache.state == ScrollabilityCache.OFF) {
9828 // FIXME: this is copied from WindowManagerService.
9829 // We should get this value from the system when it
9830 // is possible to do so.
9831 final int KEY_REPEAT_FIRST_DELAY = 750;
9832 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay);
9833 }
9834
9835 // Tell mScrollCache when we should start fading. This may
9836 // extend the fade start time if one was already scheduled
Mike Cleron3ecd58c2009-09-28 11:39:02 -07009837 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay;
Mike Cleronf116bf82009-09-27 19:14:12 -07009838 scrollCache.fadeStartTime = fadeStartTime;
9839 scrollCache.state = ScrollabilityCache.ON;
9840
9841 // Schedule our fader to run, unscheduling any old ones first
9842 if (mAttachInfo != null) {
9843 mAttachInfo.mHandler.removeCallbacks(scrollCache);
9844 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime);
9845 }
9846
9847 return true;
9848 }
9849
9850 return false;
9851 }
9852
9853 /**
Chet Haaseaceafe62011-08-26 15:44:33 -07009854 * Do not invalidate views which are not visible and which are not running an animation. They
9855 * will not get drawn and they should not set dirty flags as if they will be drawn
9856 */
9857 private boolean skipInvalidate() {
9858 return (mViewFlags & VISIBILITY_MASK) != VISIBLE && mCurrentAnimation == null &&
9859 (!(mParent instanceof ViewGroup) ||
9860 !((ViewGroup) mParent).isViewTransitioning(this));
9861 }
9862 /**
Joe Fernandez558459f2011-10-13 16:47:36 -07009863 * Mark the area defined by dirty as needing to be drawn. If the view is
Romain Guy5c22a8c2011-05-13 11:48:45 -07009864 * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some point
9865 * in the future. This must be called from a UI thread. To call from a non-UI
9866 * thread, call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009867 *
9868 * WARNING: This method is destructive to dirty.
9869 * @param dirty the rectangle representing the bounds of the dirty region
9870 */
9871 public void invalidate(Rect dirty) {
9872 if (ViewDebug.TRACE_HIERARCHY) {
9873 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
9874 }
9875
Chet Haaseaceafe62011-08-26 15:44:33 -07009876 if (skipInvalidate()) {
Chet Haasea68c5cf2011-08-22 14:27:51 -07009877 return;
9878 }
Romain Guy2fe9a8f2010-10-04 20:17:01 -07009879 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Chet Haasedaf98e92011-01-10 14:10:36 -08009880 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
9881 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009882 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Chet Haasedaf98e92011-01-10 14:10:36 -08009883 mPrivateFlags |= INVALIDATED;
Chet Haasef186f302011-09-11 11:06:06 -07009884 mPrivateFlags |= DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009885 final ViewParent p = mParent;
9886 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -08009887 //noinspection PointlessBooleanExpression,ConstantConditions
9888 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
9889 if (p != null && ai != null && ai.mHardwareAccelerated) {
9890 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07009891 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -08009892 p.invalidateChild(this, null);
9893 return;
9894 }
Romain Guyaf636eb2010-12-09 17:47:21 -08009895 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009896 if (p != null && ai != null) {
9897 final int scrollX = mScrollX;
9898 final int scrollY = mScrollY;
9899 final Rect r = ai.mTmpInvalRect;
9900 r.set(dirty.left - scrollX, dirty.top - scrollY,
9901 dirty.right - scrollX, dirty.bottom - scrollY);
9902 mParent.invalidateChild(this, r);
9903 }
9904 }
9905 }
9906
9907 /**
Joe Fernandez558459f2011-10-13 16:47:36 -07009908 * 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 -08009909 * The coordinates of the dirty rect are relative to the view.
Romain Guy5c22a8c2011-05-13 11:48:45 -07009910 * If the view is visible, {@link #onDraw(android.graphics.Canvas)}
9911 * will be called at some point in the future. This must be called from
9912 * a UI thread. To call from a non-UI thread, call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009913 * @param l the left position of the dirty region
9914 * @param t the top position of the dirty region
9915 * @param r the right position of the dirty region
9916 * @param b the bottom position of the dirty region
9917 */
9918 public void invalidate(int l, int t, int r, int b) {
9919 if (ViewDebug.TRACE_HIERARCHY) {
9920 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
9921 }
9922
Chet Haaseaceafe62011-08-26 15:44:33 -07009923 if (skipInvalidate()) {
Chet Haasea68c5cf2011-08-22 14:27:51 -07009924 return;
9925 }
Romain Guy2fe9a8f2010-10-04 20:17:01 -07009926 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Chet Haasedaf98e92011-01-10 14:10:36 -08009927 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
9928 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009929 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Chet Haasedaf98e92011-01-10 14:10:36 -08009930 mPrivateFlags |= INVALIDATED;
Chet Haasef186f302011-09-11 11:06:06 -07009931 mPrivateFlags |= DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009932 final ViewParent p = mParent;
9933 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -08009934 //noinspection PointlessBooleanExpression,ConstantConditions
9935 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
9936 if (p != null && ai != null && ai.mHardwareAccelerated) {
9937 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07009938 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -08009939 p.invalidateChild(this, null);
9940 return;
9941 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -08009942 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009943 if (p != null && ai != null && l < r && t < b) {
9944 final int scrollX = mScrollX;
9945 final int scrollY = mScrollY;
9946 final Rect tmpr = ai.mTmpInvalRect;
9947 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY);
9948 p.invalidateChild(this, tmpr);
9949 }
9950 }
9951 }
9952
9953 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07009954 * Invalidate the whole view. If the view is visible,
9955 * {@link #onDraw(android.graphics.Canvas)} will be called at some point in
9956 * the future. This must be called from a UI thread. To call from a non-UI thread,
9957 * call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009958 */
9959 public void invalidate() {
Chet Haaseed032702010-10-01 14:05:54 -07009960 invalidate(true);
9961 }
Joe Malin32736f02011-01-19 16:14:20 -08009962
Chet Haaseed032702010-10-01 14:05:54 -07009963 /**
9964 * This is where the invalidate() work actually happens. A full invalidate()
9965 * causes the drawing cache to be invalidated, but this function can be called with
9966 * invalidateCache set to false to skip that invalidation step for cases that do not
9967 * need it (for example, a component that remains at the same dimensions with the same
9968 * content).
9969 *
9970 * @param invalidateCache Whether the drawing cache for this view should be invalidated as
9971 * well. This is usually true for a full invalidate, but may be set to false if the
9972 * View's contents or dimensions have not changed.
9973 */
Romain Guy849d0a32011-02-01 17:20:48 -08009974 void invalidate(boolean invalidateCache) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009975 if (ViewDebug.TRACE_HIERARCHY) {
9976 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
9977 }
9978
Chet Haaseaceafe62011-08-26 15:44:33 -07009979 if (skipInvalidate()) {
Chet Haasea68c5cf2011-08-22 14:27:51 -07009980 return;
9981 }
Romain Guy2fe9a8f2010-10-04 20:17:01 -07009982 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Romain Guyc5d55862011-01-21 19:01:46 -08009983 (invalidateCache && (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) ||
Romain Guy0fd89bf2011-01-26 15:41:30 -08009984 (mPrivateFlags & INVALIDATED) != INVALIDATED || isOpaque() != mLastIsOpaque) {
9985 mLastIsOpaque = isOpaque();
Chet Haaseed032702010-10-01 14:05:54 -07009986 mPrivateFlags &= ~DRAWN;
Chet Haasef186f302011-09-11 11:06:06 -07009987 mPrivateFlags |= DIRTY;
Chet Haaseed032702010-10-01 14:05:54 -07009988 if (invalidateCache) {
Chet Haasedaf98e92011-01-10 14:10:36 -08009989 mPrivateFlags |= INVALIDATED;
Chet Haaseed032702010-10-01 14:05:54 -07009990 mPrivateFlags &= ~DRAWING_CACHE_VALID;
9991 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009992 final AttachInfo ai = mAttachInfo;
Chet Haase70d4ba12010-10-06 09:46:45 -07009993 final ViewParent p = mParent;
Romain Guy7d7b5492011-01-24 16:33:45 -08009994 //noinspection PointlessBooleanExpression,ConstantConditions
9995 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
9996 if (p != null && ai != null && ai.mHardwareAccelerated) {
9997 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07009998 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -08009999 p.invalidateChild(this, null);
10000 return;
10001 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -080010002 }
Michael Jurkaebefea42010-11-15 16:04:01 -080010003
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010004 if (p != null && ai != null) {
10005 final Rect r = ai.mTmpInvalRect;
10006 r.set(0, 0, mRight - mLeft, mBottom - mTop);
10007 // Don't call invalidate -- we don't want to internally scroll
10008 // our own bounds
10009 p.invalidateChild(this, r);
10010 }
10011 }
10012 }
10013
10014 /**
Chet Haase9d1992d2012-03-13 11:03:25 -070010015 * Quick invalidation for View property changes (alpha, translationXY, etc.). We don't want to
10016 * set any flags or handle all of the cases handled by the default invalidation methods.
10017 * Instead, we just want to schedule a traversal in ViewRootImpl with the appropriate
10018 * dirty rect. This method calls into fast invalidation methods in ViewGroup that
10019 * walk up the hierarchy, transforming the dirty rect as necessary.
10020 *
10021 * The method also handles normal invalidation logic if display list properties are not
10022 * being used in this view. The invalidateParent and forceRedraw flags are used by that
10023 * backup approach, to handle these cases used in the various property-setting methods.
10024 *
10025 * @param invalidateParent Force a call to invalidateParentCaches() if display list properties
10026 * are not being used in this view
10027 * @param forceRedraw Mark the view as DRAWN to force the invalidation to propagate, if display
10028 * list properties are not being used in this view
10029 */
10030 void invalidateViewProperty(boolean invalidateParent, boolean forceRedraw) {
Chet Haase1271e2c2012-04-20 09:54:27 -070010031 if (mDisplayList == null || (mPrivateFlags & DRAW_ANIMATION) == DRAW_ANIMATION) {
Chet Haase9d1992d2012-03-13 11:03:25 -070010032 if (invalidateParent) {
10033 invalidateParentCaches();
10034 }
10035 if (forceRedraw) {
10036 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
10037 }
10038 invalidate(false);
10039 } else {
10040 final AttachInfo ai = mAttachInfo;
10041 final ViewParent p = mParent;
10042 if (p != null && ai != null) {
10043 final Rect r = ai.mTmpInvalRect;
10044 r.set(0, 0, mRight - mLeft, mBottom - mTop);
10045 if (mParent instanceof ViewGroup) {
10046 ((ViewGroup) mParent).invalidateChildFast(this, r);
10047 } else {
10048 mParent.invalidateChild(this, r);
10049 }
10050 }
10051 }
10052 }
10053
10054 /**
10055 * Utility method to transform a given Rect by the current matrix of this view.
10056 */
10057 void transformRect(final Rect rect) {
10058 if (!getMatrix().isIdentity()) {
10059 RectF boundingRect = mAttachInfo.mTmpTransformRect;
10060 boundingRect.set(rect);
10061 getMatrix().mapRect(boundingRect);
10062 rect.set((int) (boundingRect.left - 0.5f),
10063 (int) (boundingRect.top - 0.5f),
10064 (int) (boundingRect.right + 0.5f),
10065 (int) (boundingRect.bottom + 0.5f));
10066 }
10067 }
10068
10069 /**
Romain Guy0fd89bf2011-01-26 15:41:30 -080010070 * Used to indicate that the parent of this view should clear its caches. This functionality
Chet Haasedaf98e92011-01-10 14:10:36 -080010071 * is used to force the parent to rebuild its display list (when hardware-accelerated),
10072 * which is necessary when various parent-managed properties of the view change, such as
Romain Guy0fd89bf2011-01-26 15:41:30 -080010073 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method only
10074 * clears the parent caches and does not causes an invalidate event.
Chet Haasedaf98e92011-01-10 14:10:36 -080010075 *
10076 * @hide
10077 */
Romain Guy0fd89bf2011-01-26 15:41:30 -080010078 protected void invalidateParentCaches() {
10079 if (mParent instanceof View) {
10080 ((View) mParent).mPrivateFlags |= INVALIDATED;
10081 }
10082 }
Joe Malin32736f02011-01-19 16:14:20 -080010083
Romain Guy0fd89bf2011-01-26 15:41:30 -080010084 /**
10085 * Used to indicate that the parent of this view should be invalidated. This functionality
10086 * is used to force the parent to rebuild its display list (when hardware-accelerated),
10087 * which is necessary when various parent-managed properties of the view change, such as
10088 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method will propagate
10089 * an invalidation event to the parent.
10090 *
10091 * @hide
10092 */
10093 protected void invalidateParentIfNeeded() {
Chet Haasedaf98e92011-01-10 14:10:36 -080010094 if (isHardwareAccelerated() && mParent instanceof View) {
Romain Guy0fd89bf2011-01-26 15:41:30 -080010095 ((View) mParent).invalidate(true);
Chet Haasedaf98e92011-01-10 14:10:36 -080010096 }
10097 }
10098
10099 /**
Romain Guy24443ea2009-05-11 11:56:30 -070010100 * Indicates whether this View is opaque. An opaque View guarantees that it will
10101 * draw all the pixels overlapping its bounds using a fully opaque color.
10102 *
10103 * Subclasses of View should override this method whenever possible to indicate
10104 * whether an instance is opaque. Opaque Views are treated in a special way by
10105 * the View hierarchy, possibly allowing it to perform optimizations during
10106 * invalidate/draw passes.
Romain Guy8506ab42009-06-11 17:35:47 -070010107 *
Romain Guy24443ea2009-05-11 11:56:30 -070010108 * @return True if this View is guaranteed to be fully opaque, false otherwise.
Romain Guy24443ea2009-05-11 11:56:30 -070010109 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070010110 @ViewDebug.ExportedProperty(category = "drawing")
Romain Guy24443ea2009-05-11 11:56:30 -070010111 public boolean isOpaque() {
Chet Haase70d4ba12010-10-06 09:46:45 -070010112 return (mPrivateFlags & OPAQUE_MASK) == OPAQUE_MASK &&
Dianne Hackbornddb715b2011-09-09 14:43:39 -070010113 ((mTransformationInfo != null ? mTransformationInfo.mAlpha : 1)
10114 >= 1.0f - ViewConfiguration.ALPHA_THRESHOLD);
Romain Guy8f1344f52009-05-15 16:03:59 -070010115 }
10116
Adam Powell20232d02010-12-08 21:08:53 -080010117 /**
10118 * @hide
10119 */
10120 protected void computeOpaqueFlags() {
Romain Guy8f1344f52009-05-15 16:03:59 -070010121 // Opaque if:
10122 // - Has a background
10123 // - Background is opaque
10124 // - Doesn't have scrollbars or scrollbars are inside overlay
10125
Philip Milne6c8ea062012-04-03 17:38:43 -070010126 if (mBackground != null && mBackground.getOpacity() == PixelFormat.OPAQUE) {
Romain Guy8f1344f52009-05-15 16:03:59 -070010127 mPrivateFlags |= OPAQUE_BACKGROUND;
10128 } else {
10129 mPrivateFlags &= ~OPAQUE_BACKGROUND;
10130 }
10131
10132 final int flags = mViewFlags;
10133 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) ||
10134 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) {
10135 mPrivateFlags |= OPAQUE_SCROLLBARS;
10136 } else {
10137 mPrivateFlags &= ~OPAQUE_SCROLLBARS;
10138 }
10139 }
10140
10141 /**
10142 * @hide
10143 */
10144 protected boolean hasOpaqueScrollbars() {
10145 return (mPrivateFlags & OPAQUE_SCROLLBARS) == OPAQUE_SCROLLBARS;
Romain Guy24443ea2009-05-11 11:56:30 -070010146 }
10147
10148 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010149 * @return A handler associated with the thread running the View. This
10150 * handler can be used to pump events in the UI events queue.
10151 */
10152 public Handler getHandler() {
10153 if (mAttachInfo != null) {
10154 return mAttachInfo.mHandler;
10155 }
10156 return null;
10157 }
10158
10159 /**
Jeff Browna175a5b2012-02-15 19:18:31 -080010160 * Gets the view root associated with the View.
10161 * @return The view root, or null if none.
10162 * @hide
10163 */
10164 public ViewRootImpl getViewRootImpl() {
10165 if (mAttachInfo != null) {
10166 return mAttachInfo.mViewRootImpl;
10167 }
10168 return null;
10169 }
10170
10171 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010172 * <p>Causes the Runnable to be added to the message queue.
10173 * The runnable will be run on the user interface thread.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010174 *
Romain Guye63a4f32011-08-11 11:33:31 -070010175 * <p>This method can be invoked from outside of the UI thread
10176 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010177 *
10178 * @param action The Runnable that will be executed.
10179 *
10180 * @return Returns true if the Runnable was successfully placed in to the
10181 * message queue. Returns false on failure, usually because the
10182 * looper processing the message queue is exiting.
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010183 *
10184 * @see #postDelayed
10185 * @see #removeCallbacks
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010186 */
10187 public boolean post(Runnable action) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010188 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010189 if (attachInfo != null) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010190 return attachInfo.mHandler.post(action);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010191 }
Jeff Browna175a5b2012-02-15 19:18:31 -080010192 // Assume that post will succeed later
10193 ViewRootImpl.getRunQueue().post(action);
10194 return true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010195 }
10196
10197 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010198 * <p>Causes the Runnable to be added to the message queue, to be run
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010199 * after the specified amount of time elapses.
Romain Guye63a4f32011-08-11 11:33:31 -070010200 * The runnable will be run on the user interface thread.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010201 *
Romain Guye63a4f32011-08-11 11:33:31 -070010202 * <p>This method can be invoked from outside of the UI thread
10203 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010204 *
10205 * @param action The Runnable that will be executed.
10206 * @param delayMillis The delay (in milliseconds) until the Runnable
10207 * will be executed.
10208 *
10209 * @return true if the Runnable was successfully placed in to the
10210 * message queue. Returns false on failure, usually because the
10211 * looper processing the message queue is exiting. Note that a
10212 * result of true does not mean the Runnable will be processed --
10213 * if the looper is quit before the delivery time of the message
10214 * occurs then the message will be dropped.
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010215 *
10216 * @see #post
10217 * @see #removeCallbacks
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010218 */
10219 public boolean postDelayed(Runnable action, long delayMillis) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010220 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010221 if (attachInfo != null) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010222 return attachInfo.mHandler.postDelayed(action, delayMillis);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010223 }
Jeff Browna175a5b2012-02-15 19:18:31 -080010224 // Assume that post will succeed later
10225 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis);
10226 return true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010227 }
10228
10229 /**
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010230 * <p>Causes the Runnable to execute on the next animation time step.
10231 * The runnable will be run on the user interface thread.</p>
10232 *
10233 * <p>This method can be invoked from outside of the UI thread
10234 * only when this View is attached to a window.</p>
10235 *
10236 * @param action The Runnable that will be executed.
10237 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010238 * @see #postOnAnimationDelayed
10239 * @see #removeCallbacks
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010240 */
10241 public void postOnAnimation(Runnable action) {
10242 final AttachInfo attachInfo = mAttachInfo;
10243 if (attachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070010244 attachInfo.mViewRootImpl.mChoreographer.postCallback(
10245 Choreographer.CALLBACK_ANIMATION, action, null);
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010246 } else {
10247 // Assume that post will succeed later
10248 ViewRootImpl.getRunQueue().post(action);
10249 }
10250 }
10251
10252 /**
10253 * <p>Causes the Runnable to execute on the next animation time step,
10254 * after the specified amount of time elapses.
10255 * The runnable will be run on the user interface thread.</p>
10256 *
10257 * <p>This method can be invoked from outside of the UI thread
10258 * only when this View is attached to a window.</p>
10259 *
10260 * @param action The Runnable that will be executed.
10261 * @param delayMillis The delay (in milliseconds) until the Runnable
10262 * will be executed.
10263 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010264 * @see #postOnAnimation
10265 * @see #removeCallbacks
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010266 */
10267 public void postOnAnimationDelayed(Runnable action, long delayMillis) {
10268 final AttachInfo attachInfo = mAttachInfo;
10269 if (attachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070010270 attachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed(
10271 Choreographer.CALLBACK_ANIMATION, action, null, delayMillis);
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010272 } else {
10273 // Assume that post will succeed later
10274 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis);
10275 }
10276 }
10277
10278 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010279 * <p>Removes the specified Runnable from the message queue.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010280 *
Romain Guye63a4f32011-08-11 11:33:31 -070010281 * <p>This method can be invoked from outside of the UI thread
10282 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010283 *
10284 * @param action The Runnable to remove from the message handling queue
10285 *
10286 * @return true if this view could ask the Handler to remove the Runnable,
10287 * false otherwise. When the returned value is true, the Runnable
10288 * may or may not have been actually removed from the message queue
10289 * (for instance, if the Runnable was not in the queue already.)
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010290 *
10291 * @see #post
10292 * @see #postDelayed
10293 * @see #postOnAnimation
10294 * @see #postOnAnimationDelayed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010295 */
10296 public boolean removeCallbacks(Runnable action) {
Jeff Brown43ea54b2012-03-09 14:37:48 -080010297 if (action != null) {
10298 final AttachInfo attachInfo = mAttachInfo;
10299 if (attachInfo != null) {
10300 attachInfo.mHandler.removeCallbacks(action);
Jeff Brownebb2d8d2012-03-23 17:14:34 -070010301 attachInfo.mViewRootImpl.mChoreographer.removeCallbacks(
10302 Choreographer.CALLBACK_ANIMATION, action, null);
Jeff Brown43ea54b2012-03-09 14:37:48 -080010303 } else {
10304 // Assume that post will succeed later
10305 ViewRootImpl.getRunQueue().removeCallbacks(action);
10306 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010307 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010308 return true;
10309 }
10310
10311 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010312 * <p>Cause an invalidate to happen on a subsequent cycle through the event loop.
10313 * Use this to invalidate the View from a non-UI thread.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010314 *
Romain Guye63a4f32011-08-11 11:33:31 -070010315 * <p>This method can be invoked from outside of the UI thread
10316 * only when this View is attached to a window.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010317 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010318 * @see #invalidate()
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010319 * @see #postInvalidateDelayed(long)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010320 */
10321 public void postInvalidate() {
10322 postInvalidateDelayed(0);
10323 }
10324
10325 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010326 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle
10327 * through the event loop. Use this to invalidate the View from a non-UI thread.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010328 *
Romain Guye63a4f32011-08-11 11:33:31 -070010329 * <p>This method can be invoked from outside of the UI thread
10330 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010331 *
10332 * @param left The left coordinate of the rectangle to invalidate.
10333 * @param top The top coordinate of the rectangle to invalidate.
10334 * @param right The right coordinate of the rectangle to invalidate.
10335 * @param bottom The bottom coordinate of the rectangle to invalidate.
10336 *
10337 * @see #invalidate(int, int, int, int)
10338 * @see #invalidate(Rect)
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010339 * @see #postInvalidateDelayed(long, int, int, int, int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010340 */
10341 public void postInvalidate(int left, int top, int right, int bottom) {
10342 postInvalidateDelayed(0, left, top, right, bottom);
10343 }
10344
10345 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010346 * <p>Cause an invalidate to happen on a subsequent cycle through the event
10347 * loop. Waits for the specified amount of time.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010348 *
Romain Guye63a4f32011-08-11 11:33:31 -070010349 * <p>This method can be invoked from outside of the UI thread
10350 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010351 *
10352 * @param delayMilliseconds the duration in milliseconds to delay the
10353 * invalidation by
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010354 *
10355 * @see #invalidate()
10356 * @see #postInvalidate()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010357 */
10358 public void postInvalidateDelayed(long delayMilliseconds) {
10359 // We try only with the AttachInfo because there's no point in invalidating
10360 // if we are not attached to our window
Jeff Browna175a5b2012-02-15 19:18:31 -080010361 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010362 if (attachInfo != null) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010363 attachInfo.mViewRootImpl.dispatchInvalidateDelayed(this, delayMilliseconds);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010364 }
10365 }
10366
10367 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010368 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle
10369 * through the event loop. Waits for the specified amount of time.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010370 *
Romain Guye63a4f32011-08-11 11:33:31 -070010371 * <p>This method can be invoked from outside of the UI thread
10372 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010373 *
10374 * @param delayMilliseconds the duration in milliseconds to delay the
10375 * invalidation by
10376 * @param left The left coordinate of the rectangle to invalidate.
10377 * @param top The top coordinate of the rectangle to invalidate.
10378 * @param right The right coordinate of the rectangle to invalidate.
10379 * @param bottom The bottom coordinate of the rectangle to invalidate.
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010380 *
10381 * @see #invalidate(int, int, int, int)
10382 * @see #invalidate(Rect)
10383 * @see #postInvalidate(int, int, int, int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010384 */
10385 public void postInvalidateDelayed(long delayMilliseconds, int left, int top,
10386 int right, int bottom) {
10387
10388 // We try only with the AttachInfo because there's no point in invalidating
10389 // if we are not attached to our window
Jeff Browna175a5b2012-02-15 19:18:31 -080010390 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010391 if (attachInfo != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010392 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
10393 info.target = this;
10394 info.left = left;
10395 info.top = top;
10396 info.right = right;
10397 info.bottom = bottom;
10398
Jeff Browna175a5b2012-02-15 19:18:31 -080010399 attachInfo.mViewRootImpl.dispatchInvalidateRectDelayed(info, delayMilliseconds);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010400 }
10401 }
10402
10403 /**
Jeff Brown6cb7b462012-03-05 13:21:17 -080010404 * <p>Cause an invalidate to happen on the next animation time step, typically the
10405 * next display frame.</p>
10406 *
10407 * <p>This method can be invoked from outside of the UI thread
10408 * only when this View is attached to a window.</p>
10409 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010410 * @see #invalidate()
Jeff Brown6cb7b462012-03-05 13:21:17 -080010411 */
10412 public void postInvalidateOnAnimation() {
10413 // We try only with the AttachInfo because there's no point in invalidating
10414 // if we are not attached to our window
10415 final AttachInfo attachInfo = mAttachInfo;
10416 if (attachInfo != null) {
10417 attachInfo.mViewRootImpl.dispatchInvalidateOnAnimation(this);
10418 }
10419 }
10420
10421 /**
10422 * <p>Cause an invalidate of the specified area to happen on the next animation
10423 * time step, typically the next display frame.</p>
10424 *
10425 * <p>This method can be invoked from outside of the UI thread
10426 * only when this View is attached to a window.</p>
10427 *
10428 * @param left The left coordinate of the rectangle to invalidate.
10429 * @param top The top coordinate of the rectangle to invalidate.
10430 * @param right The right coordinate of the rectangle to invalidate.
10431 * @param bottom The bottom coordinate of the rectangle to invalidate.
10432 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010433 * @see #invalidate(int, int, int, int)
10434 * @see #invalidate(Rect)
Jeff Brown6cb7b462012-03-05 13:21:17 -080010435 */
10436 public void postInvalidateOnAnimation(int left, int top, int right, int bottom) {
10437 // We try only with the AttachInfo because there's no point in invalidating
10438 // if we are not attached to our window
10439 final AttachInfo attachInfo = mAttachInfo;
10440 if (attachInfo != null) {
10441 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
10442 info.target = this;
10443 info.left = left;
10444 info.top = top;
10445 info.right = right;
10446 info.bottom = bottom;
10447
10448 attachInfo.mViewRootImpl.dispatchInvalidateRectOnAnimation(info);
10449 }
10450 }
10451
10452 /**
Svetoslav Ganova0156172011-06-26 17:55:44 -070010453 * Post a callback to send a {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} event.
10454 * This event is sent at most once every
10455 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}.
10456 */
10457 private void postSendViewScrolledAccessibilityEventCallback() {
10458 if (mSendViewScrolledAccessibilityEvent == null) {
10459 mSendViewScrolledAccessibilityEvent = new SendViewScrolledAccessibilityEvent();
10460 }
10461 if (!mSendViewScrolledAccessibilityEvent.mIsPending) {
10462 mSendViewScrolledAccessibilityEvent.mIsPending = true;
10463 postDelayed(mSendViewScrolledAccessibilityEvent,
10464 ViewConfiguration.getSendRecurringAccessibilityEventsInterval());
10465 }
10466 }
10467
10468 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010469 * Called by a parent to request that a child update its values for mScrollX
10470 * and mScrollY if necessary. This will typically be done if the child is
10471 * animating a scroll using a {@link android.widget.Scroller Scroller}
10472 * object.
10473 */
10474 public void computeScroll() {
10475 }
10476
10477 /**
10478 * <p>Indicate whether the horizontal edges are faded when the view is
10479 * scrolled horizontally.</p>
10480 *
10481 * @return true if the horizontal edges should are faded on scroll, false
10482 * otherwise
10483 *
10484 * @see #setHorizontalFadingEdgeEnabled(boolean)
Philip Milne6c8ea062012-04-03 17:38:43 -070010485 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010486 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010487 */
10488 public boolean isHorizontalFadingEdgeEnabled() {
10489 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL;
10490 }
10491
10492 /**
10493 * <p>Define whether the horizontal edges should be faded when this view
10494 * is scrolled horizontally.</p>
10495 *
10496 * @param horizontalFadingEdgeEnabled true if the horizontal edges should
10497 * be faded when the view is scrolled
10498 * horizontally
10499 *
10500 * @see #isHorizontalFadingEdgeEnabled()
Philip Milne6c8ea062012-04-03 17:38:43 -070010501 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010502 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010503 */
10504 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) {
10505 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) {
10506 if (horizontalFadingEdgeEnabled) {
10507 initScrollCache();
10508 }
10509
10510 mViewFlags ^= FADING_EDGE_HORIZONTAL;
10511 }
10512 }
10513
10514 /**
10515 * <p>Indicate whether the vertical edges are faded when the view is
10516 * scrolled horizontally.</p>
10517 *
10518 * @return true if the vertical edges should are faded on scroll, false
10519 * otherwise
10520 *
10521 * @see #setVerticalFadingEdgeEnabled(boolean)
Philip Milne6c8ea062012-04-03 17:38:43 -070010522 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010523 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010524 */
10525 public boolean isVerticalFadingEdgeEnabled() {
10526 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL;
10527 }
10528
10529 /**
10530 * <p>Define whether the vertical edges should be faded when this view
10531 * is scrolled vertically.</p>
10532 *
10533 * @param verticalFadingEdgeEnabled true if the vertical edges should
10534 * be faded when the view is scrolled
10535 * vertically
10536 *
10537 * @see #isVerticalFadingEdgeEnabled()
Philip Milne6c8ea062012-04-03 17:38:43 -070010538 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010539 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010540 */
10541 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) {
10542 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) {
10543 if (verticalFadingEdgeEnabled) {
10544 initScrollCache();
10545 }
10546
10547 mViewFlags ^= FADING_EDGE_VERTICAL;
10548 }
10549 }
10550
10551 /**
10552 * Returns the strength, or intensity, of the top faded edge. The strength is
10553 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10554 * returns 0.0 or 1.0 but no value in between.
10555 *
10556 * Subclasses should override this method to provide a smoother fade transition
10557 * when scrolling occurs.
10558 *
10559 * @return the intensity of the top fade as a float between 0.0f and 1.0f
10560 */
10561 protected float getTopFadingEdgeStrength() {
10562 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f;
10563 }
10564
10565 /**
10566 * Returns the strength, or intensity, of the bottom faded edge. The strength is
10567 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10568 * returns 0.0 or 1.0 but no value in between.
10569 *
10570 * Subclasses should override this method to provide a smoother fade transition
10571 * when scrolling occurs.
10572 *
10573 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f
10574 */
10575 protected float getBottomFadingEdgeStrength() {
10576 return computeVerticalScrollOffset() + computeVerticalScrollExtent() <
10577 computeVerticalScrollRange() ? 1.0f : 0.0f;
10578 }
10579
10580 /**
10581 * Returns the strength, or intensity, of the left faded edge. The strength is
10582 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10583 * returns 0.0 or 1.0 but no value in between.
10584 *
10585 * Subclasses should override this method to provide a smoother fade transition
10586 * when scrolling occurs.
10587 *
10588 * @return the intensity of the left fade as a float between 0.0f and 1.0f
10589 */
10590 protected float getLeftFadingEdgeStrength() {
10591 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f;
10592 }
10593
10594 /**
10595 * Returns the strength, or intensity, of the right 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 right fade as a float between 0.0f and 1.0f
10603 */
10604 protected float getRightFadingEdgeStrength() {
10605 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() <
10606 computeHorizontalScrollRange() ? 1.0f : 0.0f;
10607 }
10608
10609 /**
10610 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The
10611 * scrollbar is not drawn by default.</p>
10612 *
10613 * @return true if the horizontal scrollbar should be painted, false
10614 * otherwise
10615 *
10616 * @see #setHorizontalScrollBarEnabled(boolean)
10617 */
10618 public boolean isHorizontalScrollBarEnabled() {
10619 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
10620 }
10621
10622 /**
10623 * <p>Define whether the horizontal scrollbar should be drawn or not. The
10624 * scrollbar is not drawn by default.</p>
10625 *
10626 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should
10627 * be painted
10628 *
10629 * @see #isHorizontalScrollBarEnabled()
10630 */
10631 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) {
10632 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) {
10633 mViewFlags ^= SCROLLBARS_HORIZONTAL;
Romain Guy8f1344f52009-05-15 16:03:59 -070010634 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070010635 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010636 }
10637 }
10638
10639 /**
10640 * <p>Indicate whether the vertical scrollbar should be drawn or not. The
10641 * scrollbar is not drawn by default.</p>
10642 *
10643 * @return true if the vertical scrollbar should be painted, false
10644 * otherwise
10645 *
10646 * @see #setVerticalScrollBarEnabled(boolean)
10647 */
10648 public boolean isVerticalScrollBarEnabled() {
10649 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL;
10650 }
10651
10652 /**
10653 * <p>Define whether the vertical scrollbar should be drawn or not. The
10654 * scrollbar is not drawn by default.</p>
10655 *
10656 * @param verticalScrollBarEnabled true if the vertical scrollbar should
10657 * be painted
10658 *
10659 * @see #isVerticalScrollBarEnabled()
10660 */
10661 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) {
10662 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) {
10663 mViewFlags ^= SCROLLBARS_VERTICAL;
Romain Guy8f1344f52009-05-15 16:03:59 -070010664 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070010665 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010666 }
10667 }
10668
Adam Powell20232d02010-12-08 21:08:53 -080010669 /**
10670 * @hide
10671 */
10672 protected void recomputePadding() {
10673 setPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010674 }
Joe Malin32736f02011-01-19 16:14:20 -080010675
Mike Cleronfe81d382009-09-28 14:22:16 -070010676 /**
10677 * Define whether scrollbars will fade when the view is not scrolling.
Joe Malin32736f02011-01-19 16:14:20 -080010678 *
Mike Cleronfe81d382009-09-28 14:22:16 -070010679 * @param fadeScrollbars wheter to enable fading
Joe Malin32736f02011-01-19 16:14:20 -080010680 *
Philip Milne6c8ea062012-04-03 17:38:43 -070010681 * @attr ref android.R.styleable#View_fadeScrollbars
Mike Cleronfe81d382009-09-28 14:22:16 -070010682 */
10683 public void setScrollbarFadingEnabled(boolean fadeScrollbars) {
10684 initScrollCache();
10685 final ScrollabilityCache scrollabilityCache = mScrollCache;
10686 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Mike Cleron52f0a642009-09-28 18:21:37 -070010687 if (fadeScrollbars) {
10688 scrollabilityCache.state = ScrollabilityCache.OFF;
10689 } else {
Mike Cleronfe81d382009-09-28 14:22:16 -070010690 scrollabilityCache.state = ScrollabilityCache.ON;
10691 }
10692 }
Joe Malin32736f02011-01-19 16:14:20 -080010693
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010694 /**
Joe Malin32736f02011-01-19 16:14:20 -080010695 *
Mike Cleron52f0a642009-09-28 18:21:37 -070010696 * Returns true if scrollbars will fade when this view is not scrolling
Joe Malin32736f02011-01-19 16:14:20 -080010697 *
Mike Cleron52f0a642009-09-28 18:21:37 -070010698 * @return true if scrollbar fading is enabled
Philip Milne6c8ea062012-04-03 17:38:43 -070010699 *
10700 * @attr ref android.R.styleable#View_fadeScrollbars
Mike Cleron52f0a642009-09-28 18:21:37 -070010701 */
10702 public boolean isScrollbarFadingEnabled() {
Joe Malin32736f02011-01-19 16:14:20 -080010703 return mScrollCache != null && mScrollCache.fadeScrollBars;
Mike Cleron52f0a642009-09-28 18:21:37 -070010704 }
Joe Malin32736f02011-01-19 16:14:20 -080010705
Mike Cleron52f0a642009-09-28 18:21:37 -070010706 /**
Philip Milne6c8ea062012-04-03 17:38:43 -070010707 *
10708 * Returns the delay before scrollbars fade.
10709 *
10710 * @return the delay before scrollbars fade
10711 *
10712 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade
10713 */
10714 public int getScrollBarDefaultDelayBeforeFade() {
10715 return mScrollCache == null ? ViewConfiguration.getScrollDefaultDelay() :
10716 mScrollCache.scrollBarDefaultDelayBeforeFade;
10717 }
10718
10719 /**
10720 * Define the delay before scrollbars fade.
10721 *
10722 * @param scrollBarDefaultDelayBeforeFade - the delay before scrollbars fade
10723 *
10724 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade
10725 */
10726 public void setScrollBarDefaultDelayBeforeFade(int scrollBarDefaultDelayBeforeFade) {
10727 getScrollCache().scrollBarDefaultDelayBeforeFade = scrollBarDefaultDelayBeforeFade;
10728 }
10729
10730 /**
10731 *
10732 * Returns the scrollbar fade duration.
10733 *
10734 * @return the scrollbar fade duration
10735 *
10736 * @attr ref android.R.styleable#View_scrollbarFadeDuration
10737 */
10738 public int getScrollBarFadeDuration() {
10739 return mScrollCache == null ? ViewConfiguration.getScrollBarFadeDuration() :
10740 mScrollCache.scrollBarFadeDuration;
10741 }
10742
10743 /**
10744 * Define the scrollbar fade duration.
10745 *
10746 * @param scrollBarFadeDuration - the scrollbar fade duration
10747 *
10748 * @attr ref android.R.styleable#View_scrollbarFadeDuration
10749 */
10750 public void setScrollBarFadeDuration(int scrollBarFadeDuration) {
10751 getScrollCache().scrollBarFadeDuration = scrollBarFadeDuration;
10752 }
10753
10754 /**
10755 *
10756 * Returns the scrollbar size.
10757 *
10758 * @return the scrollbar size
10759 *
10760 * @attr ref android.R.styleable#View_scrollbarSize
10761 */
10762 public int getScrollBarSize() {
Romain Guyeb378892012-04-12 11:33:14 -070010763 return mScrollCache == null ? ViewConfiguration.get(mContext).getScaledScrollBarSize() :
Philip Milne6c8ea062012-04-03 17:38:43 -070010764 mScrollCache.scrollBarSize;
10765 }
10766
10767 /**
10768 * Define the scrollbar size.
10769 *
10770 * @param scrollBarSize - the scrollbar size
10771 *
10772 * @attr ref android.R.styleable#View_scrollbarSize
10773 */
10774 public void setScrollBarSize(int scrollBarSize) {
10775 getScrollCache().scrollBarSize = scrollBarSize;
10776 }
10777
10778 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010779 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or
10780 * inset. When inset, they add to the padding of the view. And the scrollbars
10781 * can be drawn inside the padding area or on the edge of the view. For example,
10782 * if a view has a background drawable and you want to draw the scrollbars
10783 * inside the padding specified by the drawable, you can use
10784 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to
10785 * appear at the edge of the view, ignoring the padding, then you can use
10786 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p>
10787 * @param style the style of the scrollbars. Should be one of
10788 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET,
10789 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.
10790 * @see #SCROLLBARS_INSIDE_OVERLAY
10791 * @see #SCROLLBARS_INSIDE_INSET
10792 * @see #SCROLLBARS_OUTSIDE_OVERLAY
10793 * @see #SCROLLBARS_OUTSIDE_INSET
Philip Milne6c8ea062012-04-03 17:38:43 -070010794 *
10795 * @attr ref android.R.styleable#View_scrollbarStyle
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010796 */
10797 public void setScrollBarStyle(int style) {
10798 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) {
10799 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK);
Romain Guy8f1344f52009-05-15 16:03:59 -070010800 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070010801 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010802 }
10803 }
10804
10805 /**
10806 * <p>Returns the current scrollbar style.</p>
10807 * @return the current scrollbar style
10808 * @see #SCROLLBARS_INSIDE_OVERLAY
10809 * @see #SCROLLBARS_INSIDE_INSET
10810 * @see #SCROLLBARS_OUTSIDE_OVERLAY
10811 * @see #SCROLLBARS_OUTSIDE_INSET
Philip Milne6c8ea062012-04-03 17:38:43 -070010812 *
10813 * @attr ref android.R.styleable#View_scrollbarStyle
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010814 */
Jeff Sharkey010d7e52011-08-08 21:05:02 -070010815 @ViewDebug.ExportedProperty(mapping = {
10816 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_OVERLAY, to = "INSIDE_OVERLAY"),
10817 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_INSET, to = "INSIDE_INSET"),
10818 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_OVERLAY, to = "OUTSIDE_OVERLAY"),
10819 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_INSET, to = "OUTSIDE_INSET")
10820 })
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010821 public int getScrollBarStyle() {
10822 return mViewFlags & SCROLLBARS_STYLE_MASK;
10823 }
10824
10825 /**
10826 * <p>Compute the horizontal range that the horizontal scrollbar
10827 * represents.</p>
10828 *
10829 * <p>The range is expressed in arbitrary units that must be the same as the
10830 * units used by {@link #computeHorizontalScrollExtent()} and
10831 * {@link #computeHorizontalScrollOffset()}.</p>
10832 *
10833 * <p>The default range is the drawing width of this view.</p>
10834 *
10835 * @return the total horizontal range represented by the horizontal
10836 * scrollbar
10837 *
10838 * @see #computeHorizontalScrollExtent()
10839 * @see #computeHorizontalScrollOffset()
10840 * @see android.widget.ScrollBarDrawable
10841 */
10842 protected int computeHorizontalScrollRange() {
10843 return getWidth();
10844 }
10845
10846 /**
10847 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb
10848 * within the horizontal range. This value is used to compute the position
10849 * of the thumb within the scrollbar's track.</p>
10850 *
10851 * <p>The range is expressed in arbitrary units that must be the same as the
10852 * units used by {@link #computeHorizontalScrollRange()} and
10853 * {@link #computeHorizontalScrollExtent()}.</p>
10854 *
10855 * <p>The default offset is the scroll offset of this view.</p>
10856 *
10857 * @return the horizontal offset of the scrollbar's thumb
10858 *
10859 * @see #computeHorizontalScrollRange()
10860 * @see #computeHorizontalScrollExtent()
10861 * @see android.widget.ScrollBarDrawable
10862 */
10863 protected int computeHorizontalScrollOffset() {
10864 return mScrollX;
10865 }
10866
10867 /**
10868 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb
10869 * within the horizontal range. This value is used to compute the length
10870 * of the thumb within the scrollbar's track.</p>
10871 *
10872 * <p>The range is expressed in arbitrary units that must be the same as the
10873 * units used by {@link #computeHorizontalScrollRange()} and
10874 * {@link #computeHorizontalScrollOffset()}.</p>
10875 *
10876 * <p>The default extent is the drawing width of this view.</p>
10877 *
10878 * @return the horizontal extent of the scrollbar's thumb
10879 *
10880 * @see #computeHorizontalScrollRange()
10881 * @see #computeHorizontalScrollOffset()
10882 * @see android.widget.ScrollBarDrawable
10883 */
10884 protected int computeHorizontalScrollExtent() {
10885 return getWidth();
10886 }
10887
10888 /**
10889 * <p>Compute the vertical range that the vertical scrollbar represents.</p>
10890 *
10891 * <p>The range is expressed in arbitrary units that must be the same as the
10892 * units used by {@link #computeVerticalScrollExtent()} and
10893 * {@link #computeVerticalScrollOffset()}.</p>
10894 *
10895 * @return the total vertical range represented by the vertical scrollbar
10896 *
10897 * <p>The default range is the drawing height of this view.</p>
10898 *
10899 * @see #computeVerticalScrollExtent()
10900 * @see #computeVerticalScrollOffset()
10901 * @see android.widget.ScrollBarDrawable
10902 */
10903 protected int computeVerticalScrollRange() {
10904 return getHeight();
10905 }
10906
10907 /**
10908 * <p>Compute the vertical offset of the vertical scrollbar's thumb
10909 * within the horizontal range. This value is used to compute the position
10910 * of the thumb within the scrollbar's track.</p>
10911 *
10912 * <p>The range is expressed in arbitrary units that must be the same as the
10913 * units used by {@link #computeVerticalScrollRange()} and
10914 * {@link #computeVerticalScrollExtent()}.</p>
10915 *
10916 * <p>The default offset is the scroll offset of this view.</p>
10917 *
10918 * @return the vertical offset of the scrollbar's thumb
10919 *
10920 * @see #computeVerticalScrollRange()
10921 * @see #computeVerticalScrollExtent()
10922 * @see android.widget.ScrollBarDrawable
10923 */
10924 protected int computeVerticalScrollOffset() {
10925 return mScrollY;
10926 }
10927
10928 /**
10929 * <p>Compute the vertical extent of the horizontal scrollbar's thumb
10930 * within the vertical range. This value is used to compute the length
10931 * of the thumb within the scrollbar's track.</p>
10932 *
10933 * <p>The range is expressed in arbitrary units that must be the same as the
Gilles Debunne52964242010-02-24 11:05:19 -080010934 * units used by {@link #computeVerticalScrollRange()} and
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010935 * {@link #computeVerticalScrollOffset()}.</p>
10936 *
10937 * <p>The default extent is the drawing height of this view.</p>
10938 *
10939 * @return the vertical extent of the scrollbar's thumb
10940 *
10941 * @see #computeVerticalScrollRange()
10942 * @see #computeVerticalScrollOffset()
10943 * @see android.widget.ScrollBarDrawable
10944 */
10945 protected int computeVerticalScrollExtent() {
10946 return getHeight();
10947 }
10948
10949 /**
Adam Powell69159442011-06-13 17:53:06 -070010950 * Check if this view can be scrolled horizontally in a certain direction.
10951 *
10952 * @param direction Negative to check scrolling left, positive to check scrolling right.
10953 * @return true if this view can be scrolled in the specified direction, false otherwise.
10954 */
10955 public boolean canScrollHorizontally(int direction) {
10956 final int offset = computeHorizontalScrollOffset();
10957 final int range = computeHorizontalScrollRange() - computeHorizontalScrollExtent();
10958 if (range == 0) return false;
10959 if (direction < 0) {
10960 return offset > 0;
10961 } else {
10962 return offset < range - 1;
10963 }
10964 }
10965
10966 /**
10967 * Check if this view can be scrolled vertically in a certain direction.
10968 *
10969 * @param direction Negative to check scrolling up, positive to check scrolling down.
10970 * @return true if this view can be scrolled in the specified direction, false otherwise.
10971 */
10972 public boolean canScrollVertically(int direction) {
10973 final int offset = computeVerticalScrollOffset();
10974 final int range = computeVerticalScrollRange() - computeVerticalScrollExtent();
10975 if (range == 0) return false;
10976 if (direction < 0) {
10977 return offset > 0;
10978 } else {
10979 return offset < range - 1;
10980 }
10981 }
10982
10983 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010984 * <p>Request the drawing of the horizontal and the vertical scrollbar. The
10985 * scrollbars are painted only if they have been awakened first.</p>
10986 *
10987 * @param canvas the canvas on which to draw the scrollbars
Joe Malin32736f02011-01-19 16:14:20 -080010988 *
Mike Cleronf116bf82009-09-27 19:14:12 -070010989 * @see #awakenScrollBars(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010990 */
Romain Guy1d5b3a62009-11-05 18:44:12 -080010991 protected final void onDrawScrollBars(Canvas canvas) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010992 // scrollbars are drawn only when the animation is running
10993 final ScrollabilityCache cache = mScrollCache;
10994 if (cache != null) {
Joe Malin32736f02011-01-19 16:14:20 -080010995
Mike Cleronf116bf82009-09-27 19:14:12 -070010996 int state = cache.state;
Joe Malin32736f02011-01-19 16:14:20 -080010997
Mike Cleronf116bf82009-09-27 19:14:12 -070010998 if (state == ScrollabilityCache.OFF) {
10999 return;
11000 }
Joe Malin32736f02011-01-19 16:14:20 -080011001
Mike Cleronf116bf82009-09-27 19:14:12 -070011002 boolean invalidate = false;
Joe Malin32736f02011-01-19 16:14:20 -080011003
Mike Cleronf116bf82009-09-27 19:14:12 -070011004 if (state == ScrollabilityCache.FADING) {
11005 // We're fading -- get our fade interpolation
11006 if (cache.interpolatorValues == null) {
11007 cache.interpolatorValues = new float[1];
11008 }
Joe Malin32736f02011-01-19 16:14:20 -080011009
Mike Cleronf116bf82009-09-27 19:14:12 -070011010 float[] values = cache.interpolatorValues;
Joe Malin32736f02011-01-19 16:14:20 -080011011
Mike Cleronf116bf82009-09-27 19:14:12 -070011012 // Stops the animation if we're done
11013 if (cache.scrollBarInterpolator.timeToValues(values) ==
11014 Interpolator.Result.FREEZE_END) {
11015 cache.state = ScrollabilityCache.OFF;
11016 } else {
11017 cache.scrollBar.setAlpha(Math.round(values[0]));
11018 }
Joe Malin32736f02011-01-19 16:14:20 -080011019
11020 // This will make the scroll bars inval themselves after
Mike Cleronf116bf82009-09-27 19:14:12 -070011021 // drawing. We only want this when we're fading so that
11022 // we prevent excessive redraws
11023 invalidate = true;
11024 } else {
11025 // We're just on -- but we may have been fading before so
11026 // reset alpha
11027 cache.scrollBar.setAlpha(255);
11028 }
11029
Joe Malin32736f02011-01-19 16:14:20 -080011030
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011031 final int viewFlags = mViewFlags;
11032
11033 final boolean drawHorizontalScrollBar =
11034 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
11035 final boolean drawVerticalScrollBar =
11036 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL
11037 && !isVerticalScrollBarHidden();
11038
11039 if (drawVerticalScrollBar || drawHorizontalScrollBar) {
11040 final int width = mRight - mLeft;
11041 final int height = mBottom - mTop;
11042
11043 final ScrollBarDrawable scrollBar = cache.scrollBar;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011044
Mike Reede8853fc2009-09-04 14:01:48 -040011045 final int scrollX = mScrollX;
11046 final int scrollY = mScrollY;
11047 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0;
11048
Mike Cleronf116bf82009-09-27 19:14:12 -070011049 int left, top, right, bottom;
Joe Malin32736f02011-01-19 16:14:20 -080011050
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011051 if (drawHorizontalScrollBar) {
Adam Powell3ba67742011-01-27 14:16:55 -080011052 int size = scrollBar.getSize(false);
11053 if (size <= 0) {
11054 size = cache.scrollBarSize;
11055 }
11056
Mike Cleronf116bf82009-09-27 19:14:12 -070011057 scrollBar.setParameters(computeHorizontalScrollRange(),
Mike Reede8853fc2009-09-04 14:01:48 -040011058 computeHorizontalScrollOffset(),
11059 computeHorizontalScrollExtent(), false);
Mike Reede8853fc2009-09-04 14:01:48 -040011060 final int verticalScrollBarGap = drawVerticalScrollBar ?
Mike Cleronf116bf82009-09-27 19:14:12 -070011061 getVerticalScrollbarWidth() : 0;
Joe Malin32736f02011-01-19 16:14:20 -080011062 top = scrollY + height - size - (mUserPaddingBottom & inside);
Mike Cleronf116bf82009-09-27 19:14:12 -070011063 left = scrollX + (mPaddingLeft & inside);
11064 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap;
11065 bottom = top + size;
11066 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom);
11067 if (invalidate) {
11068 invalidate(left, top, right, bottom);
11069 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011070 }
11071
11072 if (drawVerticalScrollBar) {
Adam Powell3ba67742011-01-27 14:16:55 -080011073 int size = scrollBar.getSize(true);
11074 if (size <= 0) {
11075 size = cache.scrollBarSize;
11076 }
11077
Mike Reede8853fc2009-09-04 14:01:48 -040011078 scrollBar.setParameters(computeVerticalScrollRange(),
11079 computeVerticalScrollOffset(),
11080 computeVerticalScrollExtent(), true);
Adam Powell20232d02010-12-08 21:08:53 -080011081 switch (mVerticalScrollbarPosition) {
11082 default:
11083 case SCROLLBAR_POSITION_DEFAULT:
11084 case SCROLLBAR_POSITION_RIGHT:
11085 left = scrollX + width - size - (mUserPaddingRight & inside);
11086 break;
11087 case SCROLLBAR_POSITION_LEFT:
11088 left = scrollX + (mUserPaddingLeft & inside);
11089 break;
11090 }
Mike Cleronf116bf82009-09-27 19:14:12 -070011091 top = scrollY + (mPaddingTop & inside);
11092 right = left + size;
11093 bottom = scrollY + height - (mUserPaddingBottom & inside);
11094 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom);
11095 if (invalidate) {
11096 invalidate(left, top, right, bottom);
11097 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011098 }
11099 }
11100 }
11101 }
Romain Guy8506ab42009-06-11 17:35:47 -070011102
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011103 /**
Romain Guy8506ab42009-06-11 17:35:47 -070011104 * 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 -080011105 * FastScroller is visible.
11106 * @return whether to temporarily hide the vertical scrollbar
11107 * @hide
11108 */
11109 protected boolean isVerticalScrollBarHidden() {
11110 return false;
11111 }
11112
11113 /**
11114 * <p>Draw the horizontal scrollbar if
11115 * {@link #isHorizontalScrollBarEnabled()} returns true.</p>
11116 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011117 * @param canvas the canvas on which to draw the scrollbar
11118 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011119 *
11120 * @see #isHorizontalScrollBarEnabled()
11121 * @see #computeHorizontalScrollRange()
11122 * @see #computeHorizontalScrollExtent()
11123 * @see #computeHorizontalScrollOffset()
11124 * @see android.widget.ScrollBarDrawable
Mike Cleronf116bf82009-09-27 19:14:12 -070011125 * @hide
Mike Reed4d6fe5f2009-09-03 13:29:05 -040011126 */
Romain Guy8fb95422010-08-17 18:38:51 -070011127 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar,
11128 int l, int t, int r, int b) {
Mike Reed4d6fe5f2009-09-03 13:29:05 -040011129 scrollBar.setBounds(l, t, r, b);
Mike Reed4d6fe5f2009-09-03 13:29:05 -040011130 scrollBar.draw(canvas);
11131 }
Mike Reede8853fc2009-09-04 14:01:48 -040011132
Mike Reed4d6fe5f2009-09-03 13:29:05 -040011133 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011134 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()}
11135 * returns true.</p>
11136 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011137 * @param canvas the canvas on which to draw the scrollbar
11138 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011139 *
11140 * @see #isVerticalScrollBarEnabled()
11141 * @see #computeVerticalScrollRange()
11142 * @see #computeVerticalScrollExtent()
11143 * @see #computeVerticalScrollOffset()
11144 * @see android.widget.ScrollBarDrawable
Mike Reede8853fc2009-09-04 14:01:48 -040011145 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011146 */
Romain Guy8fb95422010-08-17 18:38:51 -070011147 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar,
11148 int l, int t, int r, int b) {
Mike Reede8853fc2009-09-04 14:01:48 -040011149 scrollBar.setBounds(l, t, r, b);
11150 scrollBar.draw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011151 }
11152
11153 /**
11154 * Implement this to do your drawing.
11155 *
11156 * @param canvas the canvas on which the background will be drawn
11157 */
11158 protected void onDraw(Canvas canvas) {
11159 }
11160
11161 /*
11162 * Caller is responsible for calling requestLayout if necessary.
11163 * (This allows addViewInLayout to not request a new layout.)
11164 */
11165 void assignParent(ViewParent parent) {
11166 if (mParent == null) {
11167 mParent = parent;
11168 } else if (parent == null) {
11169 mParent = null;
11170 } else {
11171 throw new RuntimeException("view " + this + " being added, but"
11172 + " it already has a parent");
11173 }
11174 }
11175
11176 /**
11177 * This is called when the view is attached to a window. At this point it
11178 * has a Surface and will start drawing. Note that this function is
Romain Guy5c22a8c2011-05-13 11:48:45 -070011179 * guaranteed to be called before {@link #onDraw(android.graphics.Canvas)},
11180 * however it may be called any time before the first onDraw -- including
11181 * before or after {@link #onMeasure(int, int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011182 *
11183 * @see #onDetachedFromWindow()
11184 */
11185 protected void onAttachedToWindow() {
11186 if ((mPrivateFlags & REQUEST_TRANSPARENT_REGIONS) != 0) {
11187 mParent.requestTransparentRegion(this);
11188 }
Romain Guy2a0f2282012-05-08 14:43:12 -070011189
Adam Powell8568c3a2010-04-19 14:26:11 -070011190 if ((mPrivateFlags & AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) {
11191 initialAwakenScrollBars();
11192 mPrivateFlags &= ~AWAKEN_SCROLL_BARS_ON_ATTACH;
11193 }
Romain Guy2a0f2282012-05-08 14:43:12 -070011194
Chet Haasea9b61ac2010-12-20 07:40:25 -080011195 jumpDrawablesToCurrentState();
Romain Guy2a0f2282012-05-08 14:43:12 -070011196
Fabrice Di Meglioa6461452011-08-19 15:42:04 -070011197 // Order is important here: LayoutDirection MUST be resolved before Padding
11198 // and TextDirection
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011199 resolveLayoutDirection();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011200 resolvePadding();
Fabrice Di Meglio22268862011-06-27 18:13:18 -070011201 resolveTextDirection();
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070011202 resolveTextAlignment();
Romain Guy2a0f2282012-05-08 14:43:12 -070011203
Svetoslav Ganov42138042012-03-20 11:51:39 -070011204 clearAccessibilityFocus();
Amith Yamasani4503c8d2011-06-17 12:36:14 -070011205 if (isFocused()) {
11206 InputMethodManager imm = InputMethodManager.peekInstance();
11207 imm.focusIn(this);
11208 }
Romain Guy2a0f2282012-05-08 14:43:12 -070011209
11210 if (mAttachInfo != null && mDisplayList != null) {
11211 mAttachInfo.mViewRootImpl.dequeueDisplayList(mDisplayList);
11212 }
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -070011213 }
Cibu Johny86666632010-02-22 13:01:02 -080011214
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -070011215 /**
Romain Guybb9908b2012-03-08 11:14:07 -080011216 * @see #onScreenStateChanged(int)
11217 */
11218 void dispatchScreenStateChanged(int screenState) {
11219 onScreenStateChanged(screenState);
11220 }
11221
11222 /**
11223 * This method is called whenever the state of the screen this view is
11224 * attached to changes. A state change will usually occurs when the screen
11225 * turns on or off (whether it happens automatically or the user does it
11226 * manually.)
11227 *
11228 * @param screenState The new state of the screen. Can be either
11229 * {@link #SCREEN_STATE_ON} or {@link #SCREEN_STATE_OFF}
11230 */
11231 public void onScreenStateChanged(int screenState) {
11232 }
11233
11234 /**
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011235 * Return true if the application tag in the AndroidManifest has set "supportRtl" to true
11236 */
11237 private boolean hasRtlSupport() {
11238 return mContext.getApplicationInfo().hasRtlSupport();
11239 }
11240
11241 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011242 * Resolve and cache the layout direction. LTR is set initially. This is implicitly supposing
11243 * that the parent directionality can and will be resolved before its children.
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011244 * Will call {@link View#onResolvedLayoutDirectionChanged} when resolution is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011245 * @hide
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -070011246 */
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011247 public void resolveLayoutDirection() {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011248 // Clear any previous layout direction resolution
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -070011249 mPrivateFlags2 &= ~LAYOUT_DIRECTION_RESOLVED_MASK;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011250
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011251 if (hasRtlSupport()) {
11252 // Set resolved depending on layout direction
11253 switch (getLayoutDirection()) {
11254 case LAYOUT_DIRECTION_INHERIT:
11255 // If this is root view, no need to look at parent's layout dir.
11256 if (canResolveLayoutDirection()) {
11257 ViewGroup viewGroup = ((ViewGroup) mParent);
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011258
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011259 if (viewGroup.getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) {
11260 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL;
11261 }
11262 } else {
11263 // Nothing to do, LTR by default
11264 }
11265 break;
11266 case LAYOUT_DIRECTION_RTL:
11267 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL;
11268 break;
11269 case LAYOUT_DIRECTION_LOCALE:
11270 if(isLayoutDirectionRtl(Locale.getDefault())) {
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011271 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL;
11272 }
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011273 break;
11274 default:
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011275 // Nothing to do, LTR by default
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011276 }
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011277 }
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011278
11279 // Set to resolved
11280 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED;
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011281 onResolvedLayoutDirectionChanged();
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080011282 // Resolve padding
11283 resolvePadding();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011284 }
11285
Fabrice Di Meglioaff599b2011-07-20 19:05:01 -070011286 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011287 * Called when layout direction has been resolved.
11288 *
11289 * The default implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011290 * @hide
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011291 */
11292 public void onResolvedLayoutDirectionChanged() {
11293 }
11294
11295 /**
11296 * Resolve padding depending on layout direction.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011297 * @hide
Fabrice Di Meglioaff599b2011-07-20 19:05:01 -070011298 */
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011299 public void resolvePadding() {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011300 // If the user specified the absolute padding (either with android:padding or
11301 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise
11302 // use the default padding or the padding from the background drawable
11303 // (stored at this point in mPadding*)
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011304 int resolvedLayoutDirection = getResolvedLayoutDirection();
11305 switch (resolvedLayoutDirection) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011306 case LAYOUT_DIRECTION_RTL:
11307 // Start user padding override Right user padding. Otherwise, if Right user
11308 // padding is not defined, use the default Right padding. If Right user padding
11309 // is defined, just use it.
11310 if (mUserPaddingStart >= 0) {
11311 mUserPaddingRight = mUserPaddingStart;
11312 } else if (mUserPaddingRight < 0) {
11313 mUserPaddingRight = mPaddingRight;
11314 }
11315 if (mUserPaddingEnd >= 0) {
11316 mUserPaddingLeft = mUserPaddingEnd;
11317 } else if (mUserPaddingLeft < 0) {
11318 mUserPaddingLeft = mPaddingLeft;
11319 }
11320 break;
11321 case LAYOUT_DIRECTION_LTR:
11322 default:
11323 // Start user padding override Left user padding. Otherwise, if Left user
11324 // padding is not defined, use the default left padding. If Left user padding
11325 // is defined, just use it.
Fabrice Di Megliof3e1a932011-07-15 17:15:39 -070011326 if (mUserPaddingStart >= 0) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011327 mUserPaddingLeft = mUserPaddingStart;
11328 } else if (mUserPaddingLeft < 0) {
11329 mUserPaddingLeft = mPaddingLeft;
11330 }
Fabrice Di Megliof3e1a932011-07-15 17:15:39 -070011331 if (mUserPaddingEnd >= 0) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011332 mUserPaddingRight = mUserPaddingEnd;
11333 } else if (mUserPaddingRight < 0) {
11334 mUserPaddingRight = mPaddingRight;
11335 }
11336 }
11337
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011338 mUserPaddingBottom = (mUserPaddingBottom >= 0) ? mUserPaddingBottom : mPaddingBottom;
11339
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080011340 if(isPaddingRelative()) {
11341 setPaddingRelative(mUserPaddingStart, mPaddingTop, mUserPaddingEnd, mUserPaddingBottom);
11342 } else {
11343 recomputePadding();
11344 }
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011345 onPaddingChanged(resolvedLayoutDirection);
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011346 }
11347
11348 /**
11349 * Resolve padding depending on the layout direction. Subclasses that care about
11350 * padding resolution should override this method. The default implementation does
11351 * nothing.
11352 *
11353 * @param layoutDirection the direction of the layout
11354 *
Fabrice Di Meglioe8dc07d2012-03-09 17:10:19 -080011355 * @see {@link #LAYOUT_DIRECTION_LTR}
11356 * @see {@link #LAYOUT_DIRECTION_RTL}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011357 * @hide
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011358 */
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011359 public void onPaddingChanged(int layoutDirection) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011360 }
11361
Fabrice Di Meglio2273b1e2011-09-07 15:17:40 -070011362 /**
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011363 * Check if layout direction resolution can be done.
Fabrice Di Meglio2273b1e2011-09-07 15:17:40 -070011364 *
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011365 * @return true if layout direction resolution can be done otherwise return false.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011366 * @hide
Fabrice Di Meglio2273b1e2011-09-07 15:17:40 -070011367 */
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011368 public boolean canResolveLayoutDirection() {
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011369 switch (getLayoutDirection()) {
11370 case LAYOUT_DIRECTION_INHERIT:
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011371 return (mParent != null) && (mParent instanceof ViewGroup);
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011372 default:
11373 return true;
11374 }
11375 }
11376
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011377 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011378 * Reset the resolved layout direction. Will call {@link View#onResolvedLayoutDirectionReset}
11379 * when reset is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011380 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011381 */
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011382 public void resetResolvedLayoutDirection() {
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -070011383 // Reset the current resolved bits
11384 mPrivateFlags2 &= ~LAYOUT_DIRECTION_RESOLVED_MASK;
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011385 onResolvedLayoutDirectionReset();
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080011386 // Reset also the text direction
11387 resetResolvedTextDirection();
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011388 }
11389
11390 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011391 * Called during reset of resolved layout direction.
11392 *
11393 * Subclasses need to override this method to clear cached information that depends on the
11394 * resolved layout direction, or to inform child views that inherit their layout direction.
11395 *
11396 * The default implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011397 * @hide
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011398 */
11399 public void onResolvedLayoutDirectionReset() {
11400 }
11401
11402 /**
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011403 * Check if a Locale uses an RTL script.
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011404 *
11405 * @param locale Locale to check
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011406 * @return true if the Locale uses an RTL script.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011407 * @hide
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011408 */
Fabrice Di Meglio22268862011-06-27 18:13:18 -070011409 protected static boolean isLayoutDirectionRtl(Locale locale) {
Fabrice Di Meglio3fb824b2012-02-28 17:58:31 -080011410 return (LAYOUT_DIRECTION_RTL == LocaleUtil.getLayoutDirectionFromLocale(locale));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011411 }
11412
11413 /**
11414 * This is called when the view is detached from a window. At this point it
11415 * no longer has a surface for drawing.
11416 *
11417 * @see #onAttachedToWindow()
11418 */
11419 protected void onDetachedFromWindow() {
Romain Guy8afa5152010-02-26 11:56:30 -080011420 mPrivateFlags &= ~CANCEL_NEXT_UP_EVENT;
Romain Guy6c319ca2011-01-11 14:29:25 -080011421
Romain Guya440b002010-02-24 15:57:54 -080011422 removeUnsetPressCallback();
Maryam Garrett1549dd12009-12-15 16:06:36 -050011423 removeLongPressCallback();
Adam Powell3cb8b632011-01-21 15:34:14 -080011424 removePerformClickCallback();
Svetoslav Ganova0156172011-06-26 17:55:44 -070011425 removeSendViewScrolledAccessibilityEventCallback();
Romain Guy6c319ca2011-01-11 14:29:25 -080011426
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011427 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -080011428
Romain Guya998dff2012-03-23 18:58:36 -070011429 destroyLayer(false);
Romain Guy8dd5b1e2011-01-14 17:28:51 -080011430
11431 if (mAttachInfo != null) {
Romain Guy51e4d4d2012-03-15 18:30:47 -070011432 if (mDisplayList != null) {
Romain Guy2a0f2282012-05-08 14:43:12 -070011433 mAttachInfo.mViewRootImpl.enqueueDisplayList(mDisplayList);
Romain Guy51e4d4d2012-03-15 18:30:47 -070011434 }
Jeff Browna175a5b2012-02-15 19:18:31 -080011435 mAttachInfo.mViewRootImpl.cancelInvalidate(this);
Romain Guy51e4d4d2012-03-15 18:30:47 -070011436 } else {
11437 if (mDisplayList != null) {
11438 // Should never happen
11439 mDisplayList.invalidate();
11440 }
Romain Guy8dd5b1e2011-01-14 17:28:51 -080011441 }
11442
Patrick Dubroyec84c3a2011-01-13 17:55:37 -080011443 mCurrentAnimation = null;
Fabrice Di Meglio7f86c802011-07-01 15:09:24 -070011444
11445 resetResolvedLayoutDirection();
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070011446 resetResolvedTextAlignment();
Svetoslav Ganov42138042012-03-20 11:51:39 -070011447 resetAccessibilityStateChanged();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011448 }
11449
11450 /**
11451 * @return The number of times this view has been attached to a window
11452 */
11453 protected int getWindowAttachCount() {
11454 return mWindowAttachCount;
11455 }
11456
11457 /**
11458 * Retrieve a unique token identifying the window this view is attached to.
11459 * @return Return the window's token for use in
11460 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}.
11461 */
11462 public IBinder getWindowToken() {
11463 return mAttachInfo != null ? mAttachInfo.mWindowToken : null;
11464 }
11465
11466 /**
11467 * Retrieve a unique token identifying the top-level "real" window of
11468 * the window that this view is attached to. That is, this is like
11469 * {@link #getWindowToken}, except if the window this view in is a panel
11470 * window (attached to another containing window), then the token of
11471 * the containing window is returned instead.
11472 *
11473 * @return Returns the associated window token, either
11474 * {@link #getWindowToken()} or the containing window's token.
11475 */
11476 public IBinder getApplicationWindowToken() {
11477 AttachInfo ai = mAttachInfo;
11478 if (ai != null) {
11479 IBinder appWindowToken = ai.mPanelParentWindowToken;
11480 if (appWindowToken == null) {
11481 appWindowToken = ai.mWindowToken;
11482 }
11483 return appWindowToken;
11484 }
11485 return null;
11486 }
11487
11488 /**
11489 * Retrieve private session object this view hierarchy is using to
11490 * communicate with the window manager.
11491 * @return the session object to communicate with the window manager
11492 */
11493 /*package*/ IWindowSession getWindowSession() {
11494 return mAttachInfo != null ? mAttachInfo.mSession : null;
11495 }
11496
11497 /**
11498 * @param info the {@link android.view.View.AttachInfo} to associated with
11499 * this view
11500 */
11501 void dispatchAttachedToWindow(AttachInfo info, int visibility) {
11502 //System.out.println("Attached! " + this);
11503 mAttachInfo = info;
11504 mWindowAttachCount++;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080011505 // We will need to evaluate the drawable state at least once.
11506 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011507 if (mFloatingTreeObserver != null) {
11508 info.mTreeObserver.merge(mFloatingTreeObserver);
11509 mFloatingTreeObserver = null;
11510 }
11511 if ((mPrivateFlags&SCROLL_CONTAINER) != 0) {
11512 mAttachInfo.mScrollContainers.add(this);
11513 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
11514 }
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -070011515 performCollectViewAttributes(mAttachInfo, visibility);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011516 onAttachedToWindow();
Adam Powell4afd62b2011-02-18 15:02:18 -080011517
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011518 ListenerInfo li = mListenerInfo;
Adam Powell4afd62b2011-02-18 15:02:18 -080011519 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners =
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011520 li != null ? li.mOnAttachStateChangeListeners : null;
Adam Powell4afd62b2011-02-18 15:02:18 -080011521 if (listeners != null && listeners.size() > 0) {
11522 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to
11523 // perform the dispatching. The iterator is a safe guard against listeners that
11524 // could mutate the list by calling the various add/remove methods. This prevents
11525 // the array from being modified while we iterate it.
11526 for (OnAttachStateChangeListener listener : listeners) {
11527 listener.onViewAttachedToWindow(this);
11528 }
11529 }
11530
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011531 int vis = info.mWindowVisibility;
11532 if (vis != GONE) {
11533 onWindowVisibilityChanged(vis);
11534 }
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080011535 if ((mPrivateFlags&DRAWABLE_STATE_DIRTY) != 0) {
11536 // If nobody has evaluated the drawable state yet, then do it now.
11537 refreshDrawableState();
11538 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011539 }
11540
11541 void dispatchDetachedFromWindow() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011542 AttachInfo info = mAttachInfo;
11543 if (info != null) {
11544 int vis = info.mWindowVisibility;
11545 if (vis != GONE) {
11546 onWindowVisibilityChanged(GONE);
11547 }
11548 }
11549
11550 onDetachedFromWindow();
Romain Guy01d5edc2011-01-28 11:28:53 -080011551
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011552 ListenerInfo li = mListenerInfo;
Adam Powell4afd62b2011-02-18 15:02:18 -080011553 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners =
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011554 li != null ? li.mOnAttachStateChangeListeners : null;
Adam Powell4afd62b2011-02-18 15:02:18 -080011555 if (listeners != null && listeners.size() > 0) {
11556 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to
11557 // perform the dispatching. The iterator is a safe guard against listeners that
11558 // could mutate the list by calling the various add/remove methods. This prevents
11559 // the array from being modified while we iterate it.
11560 for (OnAttachStateChangeListener listener : listeners) {
11561 listener.onViewDetachedFromWindow(this);
11562 }
11563 }
11564
Romain Guy01d5edc2011-01-28 11:28:53 -080011565 if ((mPrivateFlags & SCROLL_CONTAINER_ADDED) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011566 mAttachInfo.mScrollContainers.remove(this);
11567 mPrivateFlags &= ~SCROLL_CONTAINER_ADDED;
11568 }
Romain Guy01d5edc2011-01-28 11:28:53 -080011569
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011570 mAttachInfo = null;
11571 }
11572
11573 /**
11574 * Store this view hierarchy's frozen state into the given container.
11575 *
11576 * @param container The SparseArray in which to save the view's state.
11577 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011578 * @see #restoreHierarchyState(android.util.SparseArray)
11579 * @see #dispatchSaveInstanceState(android.util.SparseArray)
11580 * @see #onSaveInstanceState()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011581 */
11582 public void saveHierarchyState(SparseArray<Parcelable> container) {
11583 dispatchSaveInstanceState(container);
11584 }
11585
11586 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -070011587 * Called by {@link #saveHierarchyState(android.util.SparseArray)} to store the state for
11588 * this view and its children. May be overridden to modify how freezing happens to a
11589 * 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 -080011590 *
11591 * @param container The SparseArray in which to save the view's state.
11592 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011593 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
11594 * @see #saveHierarchyState(android.util.SparseArray)
11595 * @see #onSaveInstanceState()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011596 */
11597 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) {
11598 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) {
11599 mPrivateFlags &= ~SAVE_STATE_CALLED;
11600 Parcelable state = onSaveInstanceState();
11601 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
11602 throw new IllegalStateException(
11603 "Derived class did not call super.onSaveInstanceState()");
11604 }
11605 if (state != null) {
11606 // Log.i("View", "Freezing #" + Integer.toHexString(mID)
11607 // + ": " + state);
11608 container.put(mID, state);
11609 }
11610 }
11611 }
11612
11613 /**
11614 * Hook allowing a view to generate a representation of its internal state
11615 * that can later be used to create a new instance with that same state.
11616 * This state should only contain information that is not persistent or can
11617 * not be reconstructed later. For example, you will never store your
11618 * current position on screen because that will be computed again when a
11619 * new instance of the view is placed in its view hierarchy.
11620 * <p>
11621 * Some examples of things you may store here: the current cursor position
11622 * in a text view (but usually not the text itself since that is stored in a
11623 * content provider or other persistent storage), the currently selected
11624 * item in a list view.
11625 *
11626 * @return Returns a Parcelable object containing the view's current dynamic
11627 * state, or null if there is nothing interesting to save. The
11628 * default implementation returns null.
Philip Milne6c8ea062012-04-03 17:38:43 -070011629 * @see #onRestoreInstanceState(android.os.Parcelable)
11630 * @see #saveHierarchyState(android.util.SparseArray)
11631 * @see #dispatchSaveInstanceState(android.util.SparseArray)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011632 * @see #setSaveEnabled(boolean)
11633 */
11634 protected Parcelable onSaveInstanceState() {
11635 mPrivateFlags |= SAVE_STATE_CALLED;
11636 return BaseSavedState.EMPTY_STATE;
11637 }
11638
11639 /**
11640 * Restore this view hierarchy's frozen state from the given container.
11641 *
11642 * @param container The SparseArray which holds previously frozen states.
11643 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011644 * @see #saveHierarchyState(android.util.SparseArray)
11645 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
11646 * @see #onRestoreInstanceState(android.os.Parcelable)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011647 */
11648 public void restoreHierarchyState(SparseArray<Parcelable> container) {
11649 dispatchRestoreInstanceState(container);
11650 }
11651
11652 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -070011653 * Called by {@link #restoreHierarchyState(android.util.SparseArray)} to retrieve the
11654 * state for this view and its children. May be overridden to modify how restoring
11655 * happens to a view's children; for example, some views may want to not store state
11656 * for their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011657 *
11658 * @param container The SparseArray which holds previously saved state.
11659 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011660 * @see #dispatchSaveInstanceState(android.util.SparseArray)
11661 * @see #restoreHierarchyState(android.util.SparseArray)
11662 * @see #onRestoreInstanceState(android.os.Parcelable)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011663 */
11664 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) {
11665 if (mID != NO_ID) {
11666 Parcelable state = container.get(mID);
11667 if (state != null) {
11668 // Log.i("View", "Restoreing #" + Integer.toHexString(mID)
11669 // + ": " + state);
11670 mPrivateFlags &= ~SAVE_STATE_CALLED;
11671 onRestoreInstanceState(state);
11672 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
11673 throw new IllegalStateException(
11674 "Derived class did not call super.onRestoreInstanceState()");
11675 }
11676 }
11677 }
11678 }
11679
11680 /**
11681 * Hook allowing a view to re-apply a representation of its internal state that had previously
11682 * been generated by {@link #onSaveInstanceState}. This function will never be called with a
11683 * null state.
11684 *
11685 * @param state The frozen state that had previously been returned by
11686 * {@link #onSaveInstanceState}.
11687 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011688 * @see #onSaveInstanceState()
11689 * @see #restoreHierarchyState(android.util.SparseArray)
11690 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011691 */
11692 protected void onRestoreInstanceState(Parcelable state) {
11693 mPrivateFlags |= SAVE_STATE_CALLED;
11694 if (state != BaseSavedState.EMPTY_STATE && state != null) {
Romain Guy237c1ce2009-12-08 11:30:25 -080011695 throw new IllegalArgumentException("Wrong state class, expecting View State but "
11696 + "received " + state.getClass().toString() + " instead. This usually happens "
Joe Malin32736f02011-01-19 16:14:20 -080011697 + "when two views of different type have the same id in the same hierarchy. "
11698 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure "
Romain Guy237c1ce2009-12-08 11:30:25 -080011699 + "other views do not use the same id.");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011700 }
11701 }
11702
11703 /**
11704 * <p>Return the time at which the drawing of the view hierarchy started.</p>
11705 *
11706 * @return the drawing start time in milliseconds
11707 */
11708 public long getDrawingTime() {
11709 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0;
11710 }
11711
11712 /**
11713 * <p>Enables or disables the duplication of the parent's state into this view. When
11714 * duplication is enabled, this view gets its drawable state from its parent rather
11715 * than from its own internal properties.</p>
11716 *
11717 * <p>Note: in the current implementation, setting this property to true after the
11718 * view was added to a ViewGroup might have no effect at all. This property should
11719 * always be used from XML or set to true before adding this view to a ViewGroup.</p>
11720 *
11721 * <p>Note: if this view's parent addStateFromChildren property is enabled and this
11722 * property is enabled, an exception will be thrown.</p>
Joe Malin32736f02011-01-19 16:14:20 -080011723 *
Gilles Debunnefb817032011-01-13 13:52:49 -080011724 * <p>Note: if the child view uses and updates additionnal states which are unknown to the
11725 * parent, these states should not be affected by this method.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011726 *
11727 * @param enabled True to enable duplication of the parent's drawable state, false
11728 * to disable it.
11729 *
11730 * @see #getDrawableState()
11731 * @see #isDuplicateParentStateEnabled()
11732 */
11733 public void setDuplicateParentStateEnabled(boolean enabled) {
11734 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE);
11735 }
11736
11737 /**
11738 * <p>Indicates whether this duplicates its drawable state from its parent.</p>
11739 *
11740 * @return True if this view's drawable state is duplicated from the parent,
11741 * false otherwise
11742 *
11743 * @see #getDrawableState()
11744 * @see #setDuplicateParentStateEnabled(boolean)
11745 */
11746 public boolean isDuplicateParentStateEnabled() {
11747 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE;
11748 }
11749
11750 /**
Romain Guy171c5922011-01-06 10:04:23 -080011751 * <p>Specifies the type of layer backing this view. The layer can be
11752 * {@link #LAYER_TYPE_NONE disabled}, {@link #LAYER_TYPE_SOFTWARE software} or
11753 * {@link #LAYER_TYPE_HARDWARE hardware}.</p>
Joe Malin32736f02011-01-19 16:14:20 -080011754 *
Romain Guy171c5922011-01-06 10:04:23 -080011755 * <p>A layer is associated with an optional {@link android.graphics.Paint}
11756 * instance that controls how the layer is composed on screen. The following
11757 * properties of the paint are taken into account when composing the layer:</p>
11758 * <ul>
11759 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li>
11760 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li>
11761 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li>
11762 * </ul>
Joe Malin32736f02011-01-19 16:14:20 -080011763 *
Romain Guy171c5922011-01-06 10:04:23 -080011764 * <p>If this view has an alpha value set to < 1.0 by calling
11765 * {@link #setAlpha(float)}, the alpha value of the layer's paint is replaced by
11766 * this view's alpha value. Calling {@link #setAlpha(float)} is therefore
11767 * equivalent to setting a hardware layer on this view and providing a paint with
11768 * the desired alpha value.<p>
Joe Malin32736f02011-01-19 16:14:20 -080011769 *
Romain Guy171c5922011-01-06 10:04:23 -080011770 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE disabled},
11771 * {@link #LAYER_TYPE_SOFTWARE software} and {@link #LAYER_TYPE_HARDWARE hardware}
11772 * for more information on when and how to use layers.</p>
Joe Malin32736f02011-01-19 16:14:20 -080011773 *
Romain Guy171c5922011-01-06 10:04:23 -080011774 * @param layerType The ype of layer to use with this view, must be one of
11775 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
11776 * {@link #LAYER_TYPE_HARDWARE}
11777 * @param paint The paint used to compose the layer. This argument is optional
11778 * and can be null. It is ignored when the layer type is
11779 * {@link #LAYER_TYPE_NONE}
Joe Malin32736f02011-01-19 16:14:20 -080011780 *
11781 * @see #getLayerType()
Romain Guy171c5922011-01-06 10:04:23 -080011782 * @see #LAYER_TYPE_NONE
11783 * @see #LAYER_TYPE_SOFTWARE
11784 * @see #LAYER_TYPE_HARDWARE
Joe Malin32736f02011-01-19 16:14:20 -080011785 * @see #setAlpha(float)
11786 *
Romain Guy171c5922011-01-06 10:04:23 -080011787 * @attr ref android.R.styleable#View_layerType
11788 */
11789 public void setLayerType(int layerType, Paint paint) {
11790 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) {
Joe Malin32736f02011-01-19 16:14:20 -080011791 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, "
Romain Guy171c5922011-01-06 10:04:23 -080011792 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE");
11793 }
Chet Haasedaf98e92011-01-10 14:10:36 -080011794
Romain Guyd6cd5722011-01-17 14:42:41 -080011795 if (layerType == mLayerType) {
11796 if (layerType != LAYER_TYPE_NONE && paint != mLayerPaint) {
11797 mLayerPaint = paint == null ? new Paint() : paint;
Romain Guy0fd89bf2011-01-26 15:41:30 -080011798 invalidateParentCaches();
11799 invalidate(true);
Romain Guyd6cd5722011-01-17 14:42:41 -080011800 }
11801 return;
11802 }
Romain Guy171c5922011-01-06 10:04:23 -080011803
11804 // Destroy any previous software drawing cache if needed
Romain Guy6c319ca2011-01-11 14:29:25 -080011805 switch (mLayerType) {
Chet Haase6f33e812011-05-17 12:42:19 -070011806 case LAYER_TYPE_HARDWARE:
Romain Guya998dff2012-03-23 18:58:36 -070011807 destroyLayer(false);
Romain Guy31f2c2e2011-11-21 10:55:41 -080011808 // fall through - non-accelerated views may use software layer mechanism instead
Romain Guy6c319ca2011-01-11 14:29:25 -080011809 case LAYER_TYPE_SOFTWARE:
Romain Guy6d7475d2011-07-27 16:28:21 -070011810 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -080011811 break;
Romain Guy6c319ca2011-01-11 14:29:25 -080011812 default:
11813 break;
Romain Guy171c5922011-01-06 10:04:23 -080011814 }
11815
11816 mLayerType = layerType;
Romain Guy3a3133d2011-02-01 22:59:58 -080011817 final boolean layerDisabled = mLayerType == LAYER_TYPE_NONE;
11818 mLayerPaint = layerDisabled ? null : (paint == null ? new Paint() : paint);
11819 mLocalDirtyRect = layerDisabled ? null : new Rect();
Romain Guy171c5922011-01-06 10:04:23 -080011820
Romain Guy0fd89bf2011-01-26 15:41:30 -080011821 invalidateParentCaches();
11822 invalidate(true);
Romain Guy171c5922011-01-06 10:04:23 -080011823 }
11824
11825 /**
Romain Guy59c7f802011-09-29 17:21:45 -070011826 * Indicates whether this view has a static layer. A view with layer type
11827 * {@link #LAYER_TYPE_NONE} is a static layer. Other types of layers are
11828 * dynamic.
11829 */
11830 boolean hasStaticLayer() {
Romain Guy2bf68f02012-03-02 13:37:47 -080011831 return true;
Romain Guy59c7f802011-09-29 17:21:45 -070011832 }
11833
11834 /**
Romain Guy171c5922011-01-06 10:04:23 -080011835 * Indicates what type of layer is currently associated with this view. By default
11836 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}.
11837 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)}
11838 * for more information on the different types of layers.
Joe Malin32736f02011-01-19 16:14:20 -080011839 *
Romain Guy171c5922011-01-06 10:04:23 -080011840 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
11841 * {@link #LAYER_TYPE_HARDWARE}
Joe Malin32736f02011-01-19 16:14:20 -080011842 *
11843 * @see #setLayerType(int, android.graphics.Paint)
Philip Milne6c8ea062012-04-03 17:38:43 -070011844 * @see #buildLayer()
Romain Guy171c5922011-01-06 10:04:23 -080011845 * @see #LAYER_TYPE_NONE
11846 * @see #LAYER_TYPE_SOFTWARE
11847 * @see #LAYER_TYPE_HARDWARE
11848 */
11849 public int getLayerType() {
11850 return mLayerType;
11851 }
Joe Malin32736f02011-01-19 16:14:20 -080011852
Romain Guy6c319ca2011-01-11 14:29:25 -080011853 /**
Romain Guyf1ae1062011-03-02 18:16:04 -080011854 * Forces this view's layer to be created and this view to be rendered
11855 * into its layer. If this view's layer type is set to {@link #LAYER_TYPE_NONE},
11856 * invoking this method will have no effect.
Philip Milne6c8ea062012-04-03 17:38:43 -070011857 *
Romain Guyf1ae1062011-03-02 18:16:04 -080011858 * This method can for instance be used to render a view into its layer before
11859 * starting an animation. If this view is complex, rendering into the layer
11860 * before starting the animation will avoid skipping frames.
Philip Milne6c8ea062012-04-03 17:38:43 -070011861 *
Romain Guyf1ae1062011-03-02 18:16:04 -080011862 * @throws IllegalStateException If this view is not attached to a window
Philip Milne6c8ea062012-04-03 17:38:43 -070011863 *
11864 * @see #setLayerType(int, android.graphics.Paint)
Romain Guyf1ae1062011-03-02 18:16:04 -080011865 */
11866 public void buildLayer() {
11867 if (mLayerType == LAYER_TYPE_NONE) return;
11868
11869 if (mAttachInfo == null) {
11870 throw new IllegalStateException("This view must be attached to a window first");
11871 }
11872
11873 switch (mLayerType) {
11874 case LAYER_TYPE_HARDWARE:
Romain Guyd0609e42011-11-21 17:21:15 -080011875 if (mAttachInfo.mHardwareRenderer != null &&
11876 mAttachInfo.mHardwareRenderer.isEnabled() &&
11877 mAttachInfo.mHardwareRenderer.validate()) {
Michael Jurka7e52caf2012-03-06 15:57:06 -080011878 getHardwareLayer();
Romain Guyd0609e42011-11-21 17:21:15 -080011879 }
Romain Guyf1ae1062011-03-02 18:16:04 -080011880 break;
11881 case LAYER_TYPE_SOFTWARE:
11882 buildDrawingCache(true);
11883 break;
11884 }
11885 }
Philip Milne6c8ea062012-04-03 17:38:43 -070011886
Romain Guy9c4b79a2011-11-10 19:23:58 -080011887 // Make sure the HardwareRenderer.validate() was invoked before calling this method
11888 void flushLayer() {
11889 if (mLayerType == LAYER_TYPE_HARDWARE && mHardwareLayer != null) {
11890 mHardwareLayer.flush();
11891 }
11892 }
Romain Guyf1ae1062011-03-02 18:16:04 -080011893
11894 /**
Romain Guy6c319ca2011-01-11 14:29:25 -080011895 * <p>Returns a hardware layer that can be used to draw this view again
11896 * without executing its draw method.</p>
11897 *
11898 * @return A HardwareLayer ready to render, or null if an error occurred.
11899 */
Michael Jurka7e52caf2012-03-06 15:57:06 -080011900 HardwareLayer getHardwareLayer() {
Romain Guyea835032011-07-28 19:24:37 -070011901 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null ||
11902 !mAttachInfo.mHardwareRenderer.isEnabled()) {
Romain Guy6c319ca2011-01-11 14:29:25 -080011903 return null;
11904 }
Philip Milne6c8ea062012-04-03 17:38:43 -070011905
Romain Guy9c4b79a2011-11-10 19:23:58 -080011906 if (!mAttachInfo.mHardwareRenderer.validate()) return null;
Romain Guy6c319ca2011-01-11 14:29:25 -080011907
11908 final int width = mRight - mLeft;
11909 final int height = mBottom - mTop;
Joe Malin32736f02011-01-19 16:14:20 -080011910
Romain Guy6c319ca2011-01-11 14:29:25 -080011911 if (width == 0 || height == 0) {
11912 return null;
11913 }
11914
11915 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || mHardwareLayer == null) {
11916 if (mHardwareLayer == null) {
11917 mHardwareLayer = mAttachInfo.mHardwareRenderer.createHardwareLayer(
11918 width, height, isOpaque());
Michael Jurka952e02b2012-03-13 18:34:35 -070011919 mLocalDirtyRect.set(0, 0, width, height);
Romain Guy6c319ca2011-01-11 14:29:25 -080011920 } else if (mHardwareLayer.getWidth() != width || mHardwareLayer.getHeight() != height) {
11921 mHardwareLayer.resize(width, height);
Michael Jurka952e02b2012-03-13 18:34:35 -070011922 mLocalDirtyRect.set(0, 0, width, height);
Romain Guy6c319ca2011-01-11 14:29:25 -080011923 }
11924
Romain Guy5cd5c3f2011-10-17 17:10:02 -070011925 // The layer is not valid if the underlying GPU resources cannot be allocated
11926 if (!mHardwareLayer.isValid()) {
11927 return null;
11928 }
11929
Chet Haasea1cff502012-02-21 13:43:44 -080011930 mHardwareLayer.redraw(getHardwareLayerDisplayList(mHardwareLayer), mLocalDirtyRect);
Michael Jurka7e52caf2012-03-06 15:57:06 -080011931 mLocalDirtyRect.setEmpty();
Romain Guy6c319ca2011-01-11 14:29:25 -080011932 }
11933
11934 return mHardwareLayer;
11935 }
Romain Guy171c5922011-01-06 10:04:23 -080011936
Romain Guy589b0bb2011-10-10 13:57:47 -070011937 /**
11938 * Destroys this View's hardware layer if possible.
Philip Milne6c8ea062012-04-03 17:38:43 -070011939 *
Romain Guy589b0bb2011-10-10 13:57:47 -070011940 * @return True if the layer was destroyed, false otherwise.
Philip Milne6c8ea062012-04-03 17:38:43 -070011941 *
11942 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy589b0bb2011-10-10 13:57:47 -070011943 * @see #LAYER_TYPE_HARDWARE
11944 */
Romain Guya998dff2012-03-23 18:58:36 -070011945 boolean destroyLayer(boolean valid) {
Romain Guy6d7475d2011-07-27 16:28:21 -070011946 if (mHardwareLayer != null) {
Romain Guy9c4b79a2011-11-10 19:23:58 -080011947 AttachInfo info = mAttachInfo;
11948 if (info != null && info.mHardwareRenderer != null &&
Romain Guya998dff2012-03-23 18:58:36 -070011949 info.mHardwareRenderer.isEnabled() &&
11950 (valid || info.mHardwareRenderer.validate())) {
Romain Guy9c4b79a2011-11-10 19:23:58 -080011951 mHardwareLayer.destroy();
11952 mHardwareLayer = null;
Romain Guy31f2c2e2011-11-21 10:55:41 -080011953
Romain Guy9c4b79a2011-11-10 19:23:58 -080011954 invalidate(true);
11955 invalidateParentCaches();
11956 }
Romain Guy65b345f2011-07-27 18:51:50 -070011957 return true;
Romain Guy6d7475d2011-07-27 16:28:21 -070011958 }
Romain Guy65b345f2011-07-27 18:51:50 -070011959 return false;
Romain Guy6d7475d2011-07-27 16:28:21 -070011960 }
11961
Romain Guy171c5922011-01-06 10:04:23 -080011962 /**
Romain Guy31f2c2e2011-11-21 10:55:41 -080011963 * Destroys all hardware rendering resources. This method is invoked
11964 * when the system needs to reclaim resources. Upon execution of this
11965 * method, you should free any OpenGL resources created by the view.
Philip Milne6c8ea062012-04-03 17:38:43 -070011966 *
Romain Guy31f2c2e2011-11-21 10:55:41 -080011967 * Note: you <strong>must</strong> call
11968 * <code>super.destroyHardwareResources()</code> when overriding
11969 * this method.
Philip Milne6c8ea062012-04-03 17:38:43 -070011970 *
Romain Guy31f2c2e2011-11-21 10:55:41 -080011971 * @hide
11972 */
11973 protected void destroyHardwareResources() {
Romain Guya998dff2012-03-23 18:58:36 -070011974 destroyLayer(true);
Romain Guy31f2c2e2011-11-21 10:55:41 -080011975 }
11976
11977 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011978 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call
11979 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a
11980 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when
11981 * the cache is enabled. To benefit from the cache, you must request the drawing cache by
11982 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not
11983 * null.</p>
Joe Malin32736f02011-01-19 16:14:20 -080011984 *
Romain Guy171c5922011-01-06 10:04:23 -080011985 * <p>Enabling the drawing cache is similar to
11986 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware
Chet Haasedaf98e92011-01-10 14:10:36 -080011987 * acceleration is turned off. When hardware acceleration is turned on, enabling the
11988 * drawing cache has no effect on rendering because the system uses a different mechanism
11989 * for acceleration which ignores the flag. If you want to use a Bitmap for the view, even
11990 * when hardware acceleration is enabled, see {@link #setLayerType(int, android.graphics.Paint)}
11991 * for information on how to enable software and hardware layers.</p>
11992 *
11993 * <p>This API can be used to manually generate
11994 * a bitmap copy of this view, by setting the flag to <code>true</code> and calling
11995 * {@link #getDrawingCache()}.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011996 *
11997 * @param enabled true to enable the drawing cache, false otherwise
11998 *
11999 * @see #isDrawingCacheEnabled()
12000 * @see #getDrawingCache()
12001 * @see #buildDrawingCache()
Joe Malin32736f02011-01-19 16:14:20 -080012002 * @see #setLayerType(int, android.graphics.Paint)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012003 */
12004 public void setDrawingCacheEnabled(boolean enabled) {
Romain Guy0211a0a2011-02-14 16:34:59 -080012005 mCachingFailed = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012006 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED);
12007 }
12008
12009 /**
12010 * <p>Indicates whether the drawing cache is enabled for this view.</p>
12011 *
12012 * @return true if the drawing cache is enabled
12013 *
12014 * @see #setDrawingCacheEnabled(boolean)
12015 * @see #getDrawingCache()
12016 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070012017 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012018 public boolean isDrawingCacheEnabled() {
12019 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED;
12020 }
12021
12022 /**
Chet Haasedaf98e92011-01-10 14:10:36 -080012023 * Debugging utility which recursively outputs the dirty state of a view and its
12024 * descendants.
Joe Malin32736f02011-01-19 16:14:20 -080012025 *
Chet Haasedaf98e92011-01-10 14:10:36 -080012026 * @hide
12027 */
Romain Guy676b1732011-02-14 14:45:33 -080012028 @SuppressWarnings({"UnusedDeclaration"})
Chet Haasedaf98e92011-01-10 14:10:36 -080012029 public void outputDirtyFlags(String indent, boolean clear, int clearMask) {
12030 Log.d("View", indent + this + " DIRTY(" + (mPrivateFlags & View.DIRTY_MASK) +
12031 ") DRAWN(" + (mPrivateFlags & DRAWN) + ")" + " CACHE_VALID(" +
12032 (mPrivateFlags & View.DRAWING_CACHE_VALID) +
12033 ") INVALIDATED(" + (mPrivateFlags & INVALIDATED) + ")");
12034 if (clear) {
12035 mPrivateFlags &= clearMask;
12036 }
12037 if (this instanceof ViewGroup) {
12038 ViewGroup parent = (ViewGroup) this;
12039 final int count = parent.getChildCount();
12040 for (int i = 0; i < count; i++) {
Romain Guy7d7b5492011-01-24 16:33:45 -080012041 final View child = parent.getChildAt(i);
Chet Haasedaf98e92011-01-10 14:10:36 -080012042 child.outputDirtyFlags(indent + " ", clear, clearMask);
12043 }
12044 }
12045 }
12046
12047 /**
12048 * This method is used by ViewGroup to cause its children to restore or recreate their
12049 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need
12050 * to recreate its own display list, which would happen if it went through the normal
12051 * draw/dispatchDraw mechanisms.
12052 *
12053 * @hide
12054 */
12055 protected void dispatchGetDisplayList() {}
Chet Haasef4ac5472011-01-27 10:30:25 -080012056
12057 /**
12058 * A view that is not attached or hardware accelerated cannot create a display list.
12059 * This method checks these conditions and returns the appropriate result.
12060 *
12061 * @return true if view has the ability to create a display list, false otherwise.
12062 *
12063 * @hide
12064 */
12065 public boolean canHaveDisplayList() {
Romain Guy676b1732011-02-14 14:45:33 -080012066 return !(mAttachInfo == null || mAttachInfo.mHardwareRenderer == null);
Chet Haasef4ac5472011-01-27 10:30:25 -080012067 }
Joe Malin32736f02011-01-19 16:14:20 -080012068
Chet Haasedaf98e92011-01-10 14:10:36 -080012069 /**
Gilles Debunneb35ab7b2011-12-05 15:54:00 -080012070 * @return The HardwareRenderer associated with that view or null if hardware rendering
12071 * is not supported or this this has not been attached to a window.
12072 *
12073 * @hide
12074 */
12075 public HardwareRenderer getHardwareRenderer() {
12076 if (mAttachInfo != null) {
12077 return mAttachInfo.mHardwareRenderer;
12078 }
12079 return null;
12080 }
12081
12082 /**
Chet Haasea1cff502012-02-21 13:43:44 -080012083 * Returns a DisplayList. If the incoming displayList is null, one will be created.
12084 * Otherwise, the same display list will be returned (after having been rendered into
12085 * along the way, depending on the invalidation state of the view).
12086 *
12087 * @param displayList The previous version of this displayList, could be null.
12088 * @param isLayer Whether the requester of the display list is a layer. If so,
12089 * the view will avoid creating a layer inside the resulting display list.
12090 * @return A new or reused DisplayList object.
12091 */
12092 private DisplayList getDisplayList(DisplayList displayList, boolean isLayer) {
12093 if (!canHaveDisplayList()) {
12094 return null;
12095 }
12096
12097 if (((mPrivateFlags & DRAWING_CACHE_VALID) == 0 ||
12098 displayList == null || !displayList.isValid() ||
12099 (!isLayer && mRecreateDisplayList))) {
12100 // Don't need to recreate the display list, just need to tell our
12101 // children to restore/recreate theirs
12102 if (displayList != null && displayList.isValid() &&
12103 !isLayer && !mRecreateDisplayList) {
12104 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
12105 mPrivateFlags &= ~DIRTY_MASK;
12106 dispatchGetDisplayList();
12107
12108 return displayList;
12109 }
12110
12111 if (!isLayer) {
12112 // If we got here, we're recreating it. Mark it as such to ensure that
12113 // we copy in child display lists into ours in drawChild()
12114 mRecreateDisplayList = true;
12115 }
12116 if (displayList == null) {
12117 final String name = getClass().getSimpleName();
12118 displayList = mAttachInfo.mHardwareRenderer.createDisplayList(name);
12119 // If we're creating a new display list, make sure our parent gets invalidated
12120 // since they will need to recreate their display list to account for this
12121 // new child display list.
12122 invalidateParentCaches();
12123 }
12124
12125 boolean caching = false;
12126 final HardwareCanvas canvas = displayList.start();
Chet Haasea1cff502012-02-21 13:43:44 -080012127 int width = mRight - mLeft;
12128 int height = mBottom - mTop;
12129
12130 try {
12131 canvas.setViewport(width, height);
12132 // The dirty rect should always be null for a display list
12133 canvas.onPreDraw(null);
12134 int layerType = (
12135 !(mParent instanceof ViewGroup) || ((ViewGroup)mParent).mDrawLayers) ?
12136 getLayerType() : LAYER_TYPE_NONE;
Chet Haase1271e2c2012-04-20 09:54:27 -070012137 if (!isLayer && layerType != LAYER_TYPE_NONE) {
Chet Haaseb85967b2012-03-26 14:37:51 -070012138 if (layerType == LAYER_TYPE_HARDWARE) {
12139 final HardwareLayer layer = getHardwareLayer();
12140 if (layer != null && layer.isValid()) {
12141 canvas.drawHardwareLayer(layer, 0, 0, mLayerPaint);
12142 } else {
12143 canvas.saveLayer(0, 0, mRight - mLeft, mBottom - mTop, mLayerPaint,
12144 Canvas.HAS_ALPHA_LAYER_SAVE_FLAG |
12145 Canvas.CLIP_TO_LAYER_SAVE_FLAG);
12146 }
12147 caching = true;
Chet Haasea1cff502012-02-21 13:43:44 -080012148 } else {
Chet Haaseb85967b2012-03-26 14:37:51 -070012149 buildDrawingCache(true);
12150 Bitmap cache = getDrawingCache(true);
12151 if (cache != null) {
12152 canvas.drawBitmap(cache, 0, 0, mLayerPaint);
12153 caching = true;
12154 }
Chet Haasea1cff502012-02-21 13:43:44 -080012155 }
Chet Haasea1cff502012-02-21 13:43:44 -080012156 } else {
12157
12158 computeScroll();
12159
Chet Haasea1cff502012-02-21 13:43:44 -080012160 canvas.translate(-mScrollX, -mScrollY);
12161 if (!isLayer) {
12162 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
12163 mPrivateFlags &= ~DIRTY_MASK;
12164 }
12165
12166 // Fast path for layouts with no backgrounds
12167 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
12168 dispatchDraw(canvas);
12169 } else {
12170 draw(canvas);
12171 }
12172 }
12173 } finally {
Chet Haasea1cff502012-02-21 13:43:44 -080012174 canvas.onPostDraw();
12175
12176 displayList.end();
Chet Haase1271e2c2012-04-20 09:54:27 -070012177 displayList.setCaching(caching);
12178 if (isLayer) {
Chet Haasea1cff502012-02-21 13:43:44 -080012179 displayList.setLeftTopRightBottom(0, 0, width, height);
12180 } else {
12181 setDisplayListProperties(displayList);
12182 }
12183 }
12184 } else if (!isLayer) {
12185 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
12186 mPrivateFlags &= ~DIRTY_MASK;
12187 }
12188
12189 return displayList;
12190 }
12191
12192 /**
12193 * Get the DisplayList for the HardwareLayer
12194 *
12195 * @param layer The HardwareLayer whose DisplayList we want
12196 * @return A DisplayList fopr the specified HardwareLayer
12197 */
12198 private DisplayList getHardwareLayerDisplayList(HardwareLayer layer) {
12199 DisplayList displayList = getDisplayList(layer.getDisplayList(), true);
12200 layer.setDisplayList(displayList);
12201 return displayList;
12202 }
12203
12204
12205 /**
Romain Guyb051e892010-09-28 19:09:36 -070012206 * <p>Returns a display list that can be used to draw this view again
12207 * without executing its draw method.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012208 *
Romain Guyb051e892010-09-28 19:09:36 -070012209 * @return A DisplayList ready to replay, or null if caching is not enabled.
Chet Haasedaf98e92011-01-10 14:10:36 -080012210 *
12211 * @hide
Romain Guyb051e892010-09-28 19:09:36 -070012212 */
Chet Haasedaf98e92011-01-10 14:10:36 -080012213 public DisplayList getDisplayList() {
Chet Haasea1cff502012-02-21 13:43:44 -080012214 mDisplayList = getDisplayList(mDisplayList, false);
Romain Guyb051e892010-09-28 19:09:36 -070012215 return mDisplayList;
12216 }
12217
12218 /**
Romain Guyfbd8f692009-06-26 14:51:58 -070012219 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012220 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012221 * @return A non-scaled bitmap representing this view or null if cache is disabled.
Joe Malin32736f02011-01-19 16:14:20 -080012222 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012223 * @see #getDrawingCache(boolean)
12224 */
12225 public Bitmap getDrawingCache() {
12226 return getDrawingCache(false);
12227 }
12228
12229 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012230 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap
12231 * is null when caching is disabled. If caching is enabled and the cache is not ready,
12232 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not
12233 * draw from the cache when the cache is enabled. To benefit from the cache, you must
12234 * request the drawing cache by calling this method and draw it on screen if the
12235 * returned bitmap is not null.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012236 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012237 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
12238 * this method will create a bitmap of the same size as this view. Because this bitmap
12239 * will be drawn scaled by the parent ViewGroup, the result on screen might show
12240 * scaling artifacts. To avoid such artifacts, you should call this method by setting
12241 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
12242 * size than the view. This implies that your application must be able to handle this
12243 * size.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012244 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012245 * @param autoScale Indicates whether the generated bitmap should be scaled based on
12246 * the current density of the screen when the application is in compatibility
12247 * mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012248 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012249 * @return A bitmap representing this view or null if cache is disabled.
Joe Malin32736f02011-01-19 16:14:20 -080012250 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012251 * @see #setDrawingCacheEnabled(boolean)
12252 * @see #isDrawingCacheEnabled()
Romain Guyfbd8f692009-06-26 14:51:58 -070012253 * @see #buildDrawingCache(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012254 * @see #destroyDrawingCache()
12255 */
Romain Guyfbd8f692009-06-26 14:51:58 -070012256 public Bitmap getDrawingCache(boolean autoScale) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012257 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) {
12258 return null;
12259 }
12260 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) {
Romain Guyfbd8f692009-06-26 14:51:58 -070012261 buildDrawingCache(autoScale);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012262 }
Romain Guy02890fd2010-08-06 17:58:44 -070012263 return autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012264 }
12265
12266 /**
12267 * <p>Frees the resources used by the drawing cache. If you call
12268 * {@link #buildDrawingCache()} manually without calling
12269 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
12270 * should cleanup the cache with this method afterwards.</p>
12271 *
12272 * @see #setDrawingCacheEnabled(boolean)
12273 * @see #buildDrawingCache()
12274 * @see #getDrawingCache()
12275 */
12276 public void destroyDrawingCache() {
12277 if (mDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -070012278 mDrawingCache.recycle();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012279 mDrawingCache = null;
12280 }
Romain Guyfbd8f692009-06-26 14:51:58 -070012281 if (mUnscaledDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -070012282 mUnscaledDrawingCache.recycle();
Romain Guyfbd8f692009-06-26 14:51:58 -070012283 mUnscaledDrawingCache = null;
12284 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012285 }
12286
12287 /**
12288 * Setting a solid background color for the drawing cache's bitmaps will improve
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070012289 * performance and memory usage. Note, though that this should only be used if this
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012290 * view will always be drawn on top of a solid color.
12291 *
12292 * @param color The background color to use for the drawing cache's bitmap
12293 *
12294 * @see #setDrawingCacheEnabled(boolean)
12295 * @see #buildDrawingCache()
12296 * @see #getDrawingCache()
12297 */
12298 public void setDrawingCacheBackgroundColor(int color) {
Romain Guy52e2ef82010-01-14 12:11:48 -080012299 if (color != mDrawingCacheBackgroundColor) {
12300 mDrawingCacheBackgroundColor = color;
12301 mPrivateFlags &= ~DRAWING_CACHE_VALID;
12302 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012303 }
12304
12305 /**
12306 * @see #setDrawingCacheBackgroundColor(int)
12307 *
12308 * @return The background color to used for the drawing cache's bitmap
12309 */
12310 public int getDrawingCacheBackgroundColor() {
12311 return mDrawingCacheBackgroundColor;
12312 }
12313
12314 /**
Romain Guyfbd8f692009-06-26 14:51:58 -070012315 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012316 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012317 * @see #buildDrawingCache(boolean)
12318 */
12319 public void buildDrawingCache() {
12320 buildDrawingCache(false);
12321 }
Gilles Debunne2ed2eac2011-02-24 16:29:48 -080012322
Romain Guyfbd8f692009-06-26 14:51:58 -070012323 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012324 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p>
12325 *
12326 * <p>If you call {@link #buildDrawingCache()} manually without calling
12327 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
12328 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012329 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012330 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
12331 * this method will create a bitmap of the same size as this view. Because this bitmap
12332 * will be drawn scaled by the parent ViewGroup, the result on screen might show
12333 * scaling artifacts. To avoid such artifacts, you should call this method by setting
12334 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
12335 * size than the view. This implies that your application must be able to handle this
12336 * size.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012337 *
Romain Guy0d9275e2010-10-26 14:22:30 -070012338 * <p>You should avoid calling this method when hardware acceleration is enabled. If
12339 * you do not need the drawing cache bitmap, calling this method will increase memory
Joe Malin32736f02011-01-19 16:14:20 -080012340 * usage and cause the view to be rendered in software once, thus negatively impacting
Romain Guy0d9275e2010-10-26 14:22:30 -070012341 * performance.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012342 *
12343 * @see #getDrawingCache()
12344 * @see #destroyDrawingCache()
12345 */
Romain Guyfbd8f692009-06-26 14:51:58 -070012346 public void buildDrawingCache(boolean autoScale) {
12347 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || (autoScale ?
Romain Guy02890fd2010-08-06 17:58:44 -070012348 mDrawingCache == null : mUnscaledDrawingCache == null)) {
Romain Guy0211a0a2011-02-14 16:34:59 -080012349 mCachingFailed = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012350
12351 if (ViewDebug.TRACE_HIERARCHY) {
12352 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.BUILD_CACHE);
12353 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012354
Romain Guy8506ab42009-06-11 17:35:47 -070012355 int width = mRight - mLeft;
12356 int height = mBottom - mTop;
12357
12358 final AttachInfo attachInfo = mAttachInfo;
Romain Guye1123222009-06-29 14:24:56 -070012359 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired;
Romain Guyfbd8f692009-06-26 14:51:58 -070012360
Romain Guye1123222009-06-29 14:24:56 -070012361 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -070012362 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f);
12363 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f);
Romain Guy8506ab42009-06-11 17:35:47 -070012364 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012365
12366 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor;
Romain Guy35b38ce2009-10-07 13:38:55 -070012367 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque();
Adam Powell26153a32010-11-08 15:22:27 -080012368 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012369
12370 if (width <= 0 || height <= 0 ||
Romain Guy35b38ce2009-10-07 13:38:55 -070012371 // Projected bitmap size in bytes
Adam Powell26153a32010-11-08 15:22:27 -080012372 (width * height * (opaque && !use32BitCache ? 2 : 4) >
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012373 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize())) {
12374 destroyDrawingCache();
Romain Guy0211a0a2011-02-14 16:34:59 -080012375 mCachingFailed = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012376 return;
12377 }
12378
12379 boolean clear = true;
Romain Guy02890fd2010-08-06 17:58:44 -070012380 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012381
12382 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012383 Bitmap.Config quality;
12384 if (!opaque) {
Romain Guy676b1732011-02-14 14:45:33 -080012385 // Never pick ARGB_4444 because it looks awful
12386 // Keep the DRAWING_CACHE_QUALITY_LOW flag just in case
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012387 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) {
12388 case DRAWING_CACHE_QUALITY_AUTO:
12389 quality = Bitmap.Config.ARGB_8888;
12390 break;
12391 case DRAWING_CACHE_QUALITY_LOW:
Romain Guy676b1732011-02-14 14:45:33 -080012392 quality = Bitmap.Config.ARGB_8888;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012393 break;
12394 case DRAWING_CACHE_QUALITY_HIGH:
12395 quality = Bitmap.Config.ARGB_8888;
12396 break;
12397 default:
12398 quality = Bitmap.Config.ARGB_8888;
12399 break;
12400 }
12401 } else {
Romain Guy35b38ce2009-10-07 13:38:55 -070012402 // Optimization for translucent windows
12403 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy()
Adam Powell26153a32010-11-08 15:22:27 -080012404 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012405 }
12406
12407 // Try to cleanup memory
12408 if (bitmap != null) bitmap.recycle();
12409
12410 try {
12411 bitmap = Bitmap.createBitmap(width, height, quality);
Dianne Hackborn11ea3342009-07-22 21:48:55 -070012412 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
Romain Guyfbd8f692009-06-26 14:51:58 -070012413 if (autoScale) {
Romain Guy02890fd2010-08-06 17:58:44 -070012414 mDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -070012415 } else {
Romain Guy02890fd2010-08-06 17:58:44 -070012416 mUnscaledDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -070012417 }
Adam Powell26153a32010-11-08 15:22:27 -080012418 if (opaque && use32BitCache) bitmap.setHasAlpha(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012419 } catch (OutOfMemoryError e) {
12420 // If there is not enough memory to create the bitmap cache, just
12421 // ignore the issue as bitmap caches are not required to draw the
12422 // view hierarchy
Romain Guyfbd8f692009-06-26 14:51:58 -070012423 if (autoScale) {
12424 mDrawingCache = null;
12425 } else {
12426 mUnscaledDrawingCache = null;
12427 }
Romain Guy0211a0a2011-02-14 16:34:59 -080012428 mCachingFailed = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012429 return;
12430 }
12431
12432 clear = drawingCacheBackgroundColor != 0;
12433 }
12434
12435 Canvas canvas;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012436 if (attachInfo != null) {
12437 canvas = attachInfo.mCanvas;
12438 if (canvas == null) {
12439 canvas = new Canvas();
12440 }
12441 canvas.setBitmap(bitmap);
12442 // Temporarily clobber the cached Canvas in case one of our children
12443 // is also using a drawing cache. Without this, the children would
12444 // steal the canvas by attaching their own bitmap to it and bad, bad
12445 // thing would happen (invisible views, corrupted drawings, etc.)
12446 attachInfo.mCanvas = null;
12447 } else {
12448 // This case should hopefully never or seldom happen
12449 canvas = new Canvas(bitmap);
12450 }
12451
12452 if (clear) {
12453 bitmap.eraseColor(drawingCacheBackgroundColor);
12454 }
12455
12456 computeScroll();
12457 final int restoreCount = canvas.save();
Joe Malin32736f02011-01-19 16:14:20 -080012458
Romain Guye1123222009-06-29 14:24:56 -070012459 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -070012460 final float scale = attachInfo.mApplicationScale;
12461 canvas.scale(scale, scale);
12462 }
Joe Malin32736f02011-01-19 16:14:20 -080012463
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012464 canvas.translate(-mScrollX, -mScrollY);
12465
Romain Guy5bcdff42009-05-14 21:27:18 -070012466 mPrivateFlags |= DRAWN;
Romain Guy171c5922011-01-06 10:04:23 -080012467 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated ||
12468 mLayerType != LAYER_TYPE_NONE) {
Romain Guy0d9275e2010-10-26 14:22:30 -070012469 mPrivateFlags |= DRAWING_CACHE_VALID;
12470 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012471
12472 // Fast path for layouts with no backgrounds
12473 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
12474 if (ViewDebug.TRACE_HIERARCHY) {
12475 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
12476 }
Romain Guy5bcdff42009-05-14 21:27:18 -070012477 mPrivateFlags &= ~DIRTY_MASK;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012478 dispatchDraw(canvas);
12479 } else {
12480 draw(canvas);
12481 }
12482
12483 canvas.restoreToCount(restoreCount);
Dianne Hackborn6311d0a2011-08-02 16:37:58 -070012484 canvas.setBitmap(null);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012485
12486 if (attachInfo != null) {
12487 // Restore the cached Canvas for our siblings
12488 attachInfo.mCanvas = canvas;
12489 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012490 }
12491 }
12492
12493 /**
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012494 * Create a snapshot of the view into a bitmap. We should probably make
12495 * some form of this public, but should think about the API.
12496 */
Romain Guy223ff5c2010-03-02 17:07:47 -080012497 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) {
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012498 int width = mRight - mLeft;
12499 int height = mBottom - mTop;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012500
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012501 final AttachInfo attachInfo = mAttachInfo;
Romain Guy8c11e312009-09-14 15:15:30 -070012502 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f;
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012503 width = (int) ((width * scale) + 0.5f);
12504 height = (int) ((height * scale) + 0.5f);
Joe Malin32736f02011-01-19 16:14:20 -080012505
Romain Guy8c11e312009-09-14 15:15:30 -070012506 Bitmap bitmap = Bitmap.createBitmap(width > 0 ? width : 1, height > 0 ? height : 1, quality);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012507 if (bitmap == null) {
12508 throw new OutOfMemoryError();
12509 }
12510
Romain Guyc529d8d2011-09-06 15:01:39 -070012511 Resources resources = getResources();
12512 if (resources != null) {
12513 bitmap.setDensity(resources.getDisplayMetrics().densityDpi);
12514 }
Joe Malin32736f02011-01-19 16:14:20 -080012515
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012516 Canvas canvas;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012517 if (attachInfo != null) {
12518 canvas = attachInfo.mCanvas;
12519 if (canvas == null) {
12520 canvas = new Canvas();
12521 }
12522 canvas.setBitmap(bitmap);
12523 // Temporarily clobber the cached Canvas in case one of our children
12524 // is also using a drawing cache. Without this, the children would
12525 // steal the canvas by attaching their own bitmap to it and bad, bad
12526 // things would happen (invisible views, corrupted drawings, etc.)
12527 attachInfo.mCanvas = null;
12528 } else {
12529 // This case should hopefully never or seldom happen
12530 canvas = new Canvas(bitmap);
12531 }
12532
Romain Guy5bcdff42009-05-14 21:27:18 -070012533 if ((backgroundColor & 0xff000000) != 0) {
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012534 bitmap.eraseColor(backgroundColor);
12535 }
12536
12537 computeScroll();
12538 final int restoreCount = canvas.save();
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012539 canvas.scale(scale, scale);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012540 canvas.translate(-mScrollX, -mScrollY);
12541
Romain Guy5bcdff42009-05-14 21:27:18 -070012542 // Temporarily remove the dirty mask
12543 int flags = mPrivateFlags;
12544 mPrivateFlags &= ~DIRTY_MASK;
12545
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012546 // Fast path for layouts with no backgrounds
12547 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
12548 dispatchDraw(canvas);
12549 } else {
12550 draw(canvas);
12551 }
12552
Romain Guy5bcdff42009-05-14 21:27:18 -070012553 mPrivateFlags = flags;
12554
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012555 canvas.restoreToCount(restoreCount);
Dianne Hackborn6311d0a2011-08-02 16:37:58 -070012556 canvas.setBitmap(null);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012557
12558 if (attachInfo != null) {
12559 // Restore the cached Canvas for our siblings
12560 attachInfo.mCanvas = canvas;
12561 }
Romain Guy8506ab42009-06-11 17:35:47 -070012562
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012563 return bitmap;
12564 }
12565
12566 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012567 * Indicates whether this View is currently in edit mode. A View is usually
12568 * in edit mode when displayed within a developer tool. For instance, if
12569 * this View is being drawn by a visual user interface builder, this method
12570 * should return true.
12571 *
12572 * Subclasses should check the return value of this method to provide
12573 * different behaviors if their normal behavior might interfere with the
12574 * host environment. For instance: the class spawns a thread in its
12575 * constructor, the drawing code relies on device-specific features, etc.
12576 *
12577 * This method is usually checked in the drawing code of custom widgets.
12578 *
12579 * @return True if this View is in edit mode, false otherwise.
12580 */
12581 public boolean isInEditMode() {
12582 return false;
12583 }
12584
12585 /**
12586 * If the View draws content inside its padding and enables fading edges,
12587 * it needs to support padding offsets. Padding offsets are added to the
12588 * fading edges to extend the length of the fade so that it covers pixels
12589 * drawn inside the padding.
12590 *
12591 * Subclasses of this class should override this method if they need
12592 * to draw content inside the padding.
12593 *
12594 * @return True if padding offset must be applied, false otherwise.
12595 *
12596 * @see #getLeftPaddingOffset()
12597 * @see #getRightPaddingOffset()
12598 * @see #getTopPaddingOffset()
12599 * @see #getBottomPaddingOffset()
12600 *
12601 * @since CURRENT
12602 */
12603 protected boolean isPaddingOffsetRequired() {
12604 return false;
12605 }
12606
12607 /**
12608 * Amount by which to extend the left fading region. Called only when
12609 * {@link #isPaddingOffsetRequired()} returns true.
12610 *
12611 * @return The left padding offset in pixels.
12612 *
12613 * @see #isPaddingOffsetRequired()
12614 *
12615 * @since CURRENT
12616 */
12617 protected int getLeftPaddingOffset() {
12618 return 0;
12619 }
12620
12621 /**
12622 * Amount by which to extend the right fading region. Called only when
12623 * {@link #isPaddingOffsetRequired()} returns true.
12624 *
12625 * @return The right padding offset in pixels.
12626 *
12627 * @see #isPaddingOffsetRequired()
12628 *
12629 * @since CURRENT
12630 */
12631 protected int getRightPaddingOffset() {
12632 return 0;
12633 }
12634
12635 /**
12636 * Amount by which to extend the top fading region. Called only when
12637 * {@link #isPaddingOffsetRequired()} returns true.
12638 *
12639 * @return The top padding offset in pixels.
12640 *
12641 * @see #isPaddingOffsetRequired()
12642 *
12643 * @since CURRENT
12644 */
12645 protected int getTopPaddingOffset() {
12646 return 0;
12647 }
12648
12649 /**
12650 * Amount by which to extend the bottom fading region. Called only when
12651 * {@link #isPaddingOffsetRequired()} returns true.
12652 *
12653 * @return The bottom padding offset in pixels.
12654 *
12655 * @see #isPaddingOffsetRequired()
12656 *
12657 * @since CURRENT
12658 */
12659 protected int getBottomPaddingOffset() {
12660 return 0;
12661 }
12662
12663 /**
Romain Guyf2fc4602011-07-19 15:20:03 -070012664 * @hide
12665 * @param offsetRequired
12666 */
12667 protected int getFadeTop(boolean offsetRequired) {
12668 int top = mPaddingTop;
12669 if (offsetRequired) top += getTopPaddingOffset();
12670 return top;
12671 }
Philip Milne6c8ea062012-04-03 17:38:43 -070012672
Romain Guyf2fc4602011-07-19 15:20:03 -070012673 /**
12674 * @hide
12675 * @param offsetRequired
12676 */
12677 protected int getFadeHeight(boolean offsetRequired) {
12678 int padding = mPaddingTop;
Philip Milne6c8ea062012-04-03 17:38:43 -070012679 if (offsetRequired) padding += getTopPaddingOffset();
Romain Guyf2fc4602011-07-19 15:20:03 -070012680 return mBottom - mTop - mPaddingBottom - padding;
12681 }
Philip Milne6c8ea062012-04-03 17:38:43 -070012682
Romain Guyf2fc4602011-07-19 15:20:03 -070012683 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +090012684 * <p>Indicates whether this view is attached to a hardware accelerated
Romain Guy2bffd262010-09-12 17:40:02 -070012685 * window or not.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012686 *
Romain Guy2bffd262010-09-12 17:40:02 -070012687 * <p>Even if this method returns true, it does not mean that every call
12688 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware
12689 * accelerated {@link android.graphics.Canvas}. For instance, if this view
Ken Wakasaf76a50c2012-03-09 19:56:35 +090012690 * is drawn onto an offscreen {@link android.graphics.Bitmap} and its
Romain Guy2bffd262010-09-12 17:40:02 -070012691 * window is hardware accelerated,
12692 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely
12693 * return false, and this method will return true.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012694 *
Romain Guy2bffd262010-09-12 17:40:02 -070012695 * @return True if the view is attached to a window and the window is
12696 * hardware accelerated; false in any other case.
12697 */
12698 public boolean isHardwareAccelerated() {
12699 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated;
12700 }
Joe Malin32736f02011-01-19 16:14:20 -080012701
Romain Guy2bffd262010-09-12 17:40:02 -070012702 /**
Chet Haasebcca79a2012-02-14 08:45:14 -080012703 * Utility function, called by draw(canvas, parent, drawingTime) to handle the less common
12704 * case of an active Animation being run on the view.
12705 */
12706 private boolean drawAnimation(ViewGroup parent, long drawingTime,
12707 Animation a, boolean scalingRequired) {
12708 Transformation invalidationTransform;
12709 final int flags = parent.mGroupFlags;
12710 final boolean initialized = a.isInitialized();
12711 if (!initialized) {
Chet Haase1fb8a9e2012-04-19 09:22:34 -070012712 a.initialize(mRight - mLeft, mBottom - mTop, parent.getWidth(), parent.getHeight());
Chet Haasebcca79a2012-02-14 08:45:14 -080012713 a.initializeInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop);
12714 onAnimationStart();
12715 }
12716
12717 boolean more = a.getTransformation(drawingTime, parent.mChildTransformation, 1f);
12718 if (scalingRequired && mAttachInfo.mApplicationScale != 1f) {
12719 if (parent.mInvalidationTransformation == null) {
12720 parent.mInvalidationTransformation = new Transformation();
12721 }
12722 invalidationTransform = parent.mInvalidationTransformation;
12723 a.getTransformation(drawingTime, invalidationTransform, 1f);
12724 } else {
12725 invalidationTransform = parent.mChildTransformation;
12726 }
12727 if (more) {
12728 if (!a.willChangeBounds()) {
12729 if ((flags & (parent.FLAG_OPTIMIZE_INVALIDATE | parent.FLAG_ANIMATION_DONE)) ==
12730 parent.FLAG_OPTIMIZE_INVALIDATE) {
12731 parent.mGroupFlags |= parent.FLAG_INVALIDATE_REQUIRED;
12732 } else if ((flags & parent.FLAG_INVALIDATE_REQUIRED) == 0) {
12733 // The child need to draw an animation, potentially offscreen, so
12734 // make sure we do not cancel invalidate requests
12735 parent.mPrivateFlags |= DRAW_ANIMATION;
12736 parent.invalidate(mLeft, mTop, mRight, mBottom);
12737 }
12738 } else {
12739 if (parent.mInvalidateRegion == null) {
12740 parent.mInvalidateRegion = new RectF();
12741 }
12742 final RectF region = parent.mInvalidateRegion;
12743 a.getInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop, region,
12744 invalidationTransform);
12745
12746 // The child need to draw an animation, potentially offscreen, so
12747 // make sure we do not cancel invalidate requests
12748 parent.mPrivateFlags |= DRAW_ANIMATION;
12749
12750 final int left = mLeft + (int) region.left;
12751 final int top = mTop + (int) region.top;
12752 parent.invalidate(left, top, left + (int) (region.width() + .5f),
12753 top + (int) (region.height() + .5f));
12754 }
12755 }
12756 return more;
12757 }
12758
Chet Haasea1cff502012-02-21 13:43:44 -080012759 /**
12760 * This method is called by getDisplayList() when a display list is created or re-rendered.
12761 * It sets or resets the current value of all properties on that display list (resetting is
12762 * necessary when a display list is being re-created, because we need to make sure that
12763 * previously-set transform values
12764 */
12765 void setDisplayListProperties(DisplayList displayList) {
Chet Haase1271e2c2012-04-20 09:54:27 -070012766 if (displayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -080012767 displayList.setLeftTopRightBottom(mLeft, mTop, mRight, mBottom);
Chet Haasedb8c9a62012-03-21 18:54:18 -070012768 displayList.setHasOverlappingRendering(hasOverlappingRendering());
Chet Haasea1cff502012-02-21 13:43:44 -080012769 if (mParent instanceof ViewGroup) {
12770 displayList.setClipChildren(
12771 (((ViewGroup)mParent).mGroupFlags & ViewGroup.FLAG_CLIP_CHILDREN) != 0);
12772 }
Chet Haase9420abd2012-03-29 16:28:32 -070012773 float alpha = 1;
12774 if (mParent instanceof ViewGroup && (((ViewGroup) mParent).mGroupFlags &
12775 ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) {
12776 ViewGroup parentVG = (ViewGroup) mParent;
12777 final boolean hasTransform =
12778 parentVG.getChildStaticTransformation(this, parentVG.mChildTransformation);
12779 if (hasTransform) {
12780 Transformation transform = parentVG.mChildTransformation;
12781 final int transformType = parentVG.mChildTransformation.getTransformationType();
12782 if (transformType != Transformation.TYPE_IDENTITY) {
12783 if ((transformType & Transformation.TYPE_ALPHA) != 0) {
12784 alpha = transform.getAlpha();
12785 }
12786 if ((transformType & Transformation.TYPE_MATRIX) != 0) {
12787 displayList.setStaticMatrix(transform.getMatrix());
12788 }
12789 }
12790 }
Chet Haasea1cff502012-02-21 13:43:44 -080012791 }
12792 if (mTransformationInfo != null) {
Chet Haase9420abd2012-03-29 16:28:32 -070012793 alpha *= mTransformationInfo.mAlpha;
12794 if (alpha < 1) {
12795 final int multipliedAlpha = (int) (255 * alpha);
12796 if (onSetAlpha(multipliedAlpha)) {
12797 alpha = 1;
12798 }
12799 }
12800 displayList.setTransformationInfo(alpha,
Chet Haasea1cff502012-02-21 13:43:44 -080012801 mTransformationInfo.mTranslationX, mTransformationInfo.mTranslationY,
12802 mTransformationInfo.mRotation, mTransformationInfo.mRotationX,
12803 mTransformationInfo.mRotationY, mTransformationInfo.mScaleX,
12804 mTransformationInfo.mScaleY);
Chet Haaseb85967b2012-03-26 14:37:51 -070012805 if (mTransformationInfo.mCamera == null) {
12806 mTransformationInfo.mCamera = new Camera();
12807 mTransformationInfo.matrix3D = new Matrix();
12808 }
12809 displayList.setCameraDistance(mTransformationInfo.mCamera.getLocationZ());
Chet Haasea1cff502012-02-21 13:43:44 -080012810 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == PIVOT_EXPLICITLY_SET) {
12811 displayList.setPivotX(getPivotX());
12812 displayList.setPivotY(getPivotY());
12813 }
Chet Haase9420abd2012-03-29 16:28:32 -070012814 } else if (alpha < 1) {
12815 displayList.setAlpha(alpha);
Chet Haasea1cff502012-02-21 13:43:44 -080012816 }
12817 }
12818 }
12819
Chet Haasebcca79a2012-02-14 08:45:14 -080012820 /**
Chet Haase64a48c12012-02-13 16:33:29 -080012821 * This method is called by ViewGroup.drawChild() to have each child view draw itself.
12822 * This draw() method is an implementation detail and is not intended to be overridden or
12823 * to be called from anywhere else other than ViewGroup.drawChild().
12824 */
12825 boolean draw(Canvas canvas, ViewGroup parent, long drawingTime) {
Chet Haase1271e2c2012-04-20 09:54:27 -070012826 boolean useDisplayListProperties = mAttachInfo != null && mAttachInfo.mHardwareAccelerated;
Chet Haase64a48c12012-02-13 16:33:29 -080012827 boolean more = false;
Chet Haase64a48c12012-02-13 16:33:29 -080012828 final boolean childHasIdentityMatrix = hasIdentityMatrix();
Chet Haase64a48c12012-02-13 16:33:29 -080012829 final int flags = parent.mGroupFlags;
12830
Chet Haasea1cff502012-02-21 13:43:44 -080012831 if ((flags & ViewGroup.FLAG_CLEAR_TRANSFORMATION) == ViewGroup.FLAG_CLEAR_TRANSFORMATION) {
Chet Haase64a48c12012-02-13 16:33:29 -080012832 parent.mChildTransformation.clear();
Chet Haasea1cff502012-02-21 13:43:44 -080012833 parent.mGroupFlags &= ~ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080012834 }
12835
12836 Transformation transformToApply = null;
Chet Haase64a48c12012-02-13 16:33:29 -080012837 boolean concatMatrix = false;
12838
12839 boolean scalingRequired = false;
12840 boolean caching;
12841 int layerType = parent.mDrawLayers ? getLayerType() : LAYER_TYPE_NONE;
12842
12843 final boolean hardwareAccelerated = canvas.isHardwareAccelerated();
Chet Haasea1cff502012-02-21 13:43:44 -080012844 if ((flags & ViewGroup.FLAG_CHILDREN_DRAWN_WITH_CACHE) != 0 ||
12845 (flags & ViewGroup.FLAG_ALWAYS_DRAWN_WITH_CACHE) != 0) {
Chet Haase64a48c12012-02-13 16:33:29 -080012846 caching = true;
Chet Haase9420abd2012-03-29 16:28:32 -070012847 // Auto-scaled apps are not hw-accelerated, no need to set scaling flag on DisplayList
Chet Haase64a48c12012-02-13 16:33:29 -080012848 if (mAttachInfo != null) scalingRequired = mAttachInfo.mScalingRequired;
12849 } else {
12850 caching = (layerType != LAYER_TYPE_NONE) || hardwareAccelerated;
12851 }
12852
Chet Haasebcca79a2012-02-14 08:45:14 -080012853 final Animation a = getAnimation();
Chet Haase64a48c12012-02-13 16:33:29 -080012854 if (a != null) {
Chet Haasebcca79a2012-02-14 08:45:14 -080012855 more = drawAnimation(parent, drawingTime, a, scalingRequired);
Chet Haase64a48c12012-02-13 16:33:29 -080012856 concatMatrix = a.willChangeTransformationMatrix();
Chet Haaseafd5c3e2012-05-10 13:21:10 -070012857 if (concatMatrix) {
12858 mPrivateFlags2 |= VIEW_IS_ANIMATING_TRANSFORM;
12859 }
Chet Haasebcca79a2012-02-14 08:45:14 -080012860 transformToApply = parent.mChildTransformation;
Chet Haaseafd5c3e2012-05-10 13:21:10 -070012861 } else {
12862 if ((mPrivateFlags2 & VIEW_IS_ANIMATING_TRANSFORM) == VIEW_IS_ANIMATING_TRANSFORM &&
12863 mDisplayList != null) {
12864 // No longer animating: clear out old animation matrix
12865 mDisplayList.setAnimationMatrix(null);
12866 mPrivateFlags2 &= ~VIEW_IS_ANIMATING_TRANSFORM;
12867 }
12868 if (!useDisplayListProperties &&
12869 (flags & ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) {
12870 final boolean hasTransform =
12871 parent.getChildStaticTransformation(this, parent.mChildTransformation);
12872 if (hasTransform) {
12873 final int transformType = parent.mChildTransformation.getTransformationType();
12874 transformToApply = transformType != Transformation.TYPE_IDENTITY ?
12875 parent.mChildTransformation : null;
12876 concatMatrix = (transformType & Transformation.TYPE_MATRIX) != 0;
12877 }
Chet Haase64a48c12012-02-13 16:33:29 -080012878 }
12879 }
12880
12881 concatMatrix |= !childHasIdentityMatrix;
12882
12883 // Sets the flag as early as possible to allow draw() implementations
12884 // to call invalidate() successfully when doing animations
12885 mPrivateFlags |= DRAWN;
12886
Chet Haasebcca79a2012-02-14 08:45:14 -080012887 if (!concatMatrix && canvas.quickReject(mLeft, mTop, mRight, mBottom, Canvas.EdgeType.BW) &&
Chet Haase64a48c12012-02-13 16:33:29 -080012888 (mPrivateFlags & DRAW_ANIMATION) == 0) {
Chet Haase1a3ab172012-05-11 08:41:20 -070012889 mPrivateFlags2 |= VIEW_QUICK_REJECTED;
Chet Haase64a48c12012-02-13 16:33:29 -080012890 return more;
12891 }
Chet Haase1a3ab172012-05-11 08:41:20 -070012892 mPrivateFlags2 &= ~VIEW_QUICK_REJECTED;
Chet Haase64a48c12012-02-13 16:33:29 -080012893
12894 if (hardwareAccelerated) {
12895 // Clear INVALIDATED flag to allow invalidation to occur during rendering, but
12896 // retain the flag's value temporarily in the mRecreateDisplayList flag
12897 mRecreateDisplayList = (mPrivateFlags & INVALIDATED) == INVALIDATED;
12898 mPrivateFlags &= ~INVALIDATED;
12899 }
12900
12901 computeScroll();
12902
12903 final int sx = mScrollX;
12904 final int sy = mScrollY;
12905
12906 DisplayList displayList = null;
12907 Bitmap cache = null;
12908 boolean hasDisplayList = false;
12909 if (caching) {
12910 if (!hardwareAccelerated) {
12911 if (layerType != LAYER_TYPE_NONE) {
12912 layerType = LAYER_TYPE_SOFTWARE;
12913 buildDrawingCache(true);
12914 }
12915 cache = getDrawingCache(true);
12916 } else {
12917 switch (layerType) {
12918 case LAYER_TYPE_SOFTWARE:
Chet Haaseb85967b2012-03-26 14:37:51 -070012919 if (useDisplayListProperties) {
12920 hasDisplayList = canHaveDisplayList();
12921 } else {
12922 buildDrawingCache(true);
12923 cache = getDrawingCache(true);
12924 }
Chet Haase64a48c12012-02-13 16:33:29 -080012925 break;
Chet Haasea1cff502012-02-21 13:43:44 -080012926 case LAYER_TYPE_HARDWARE:
12927 if (useDisplayListProperties) {
12928 hasDisplayList = canHaveDisplayList();
12929 }
12930 break;
Chet Haase64a48c12012-02-13 16:33:29 -080012931 case LAYER_TYPE_NONE:
12932 // Delay getting the display list until animation-driven alpha values are
12933 // set up and possibly passed on to the view
12934 hasDisplayList = canHaveDisplayList();
12935 break;
12936 }
12937 }
12938 }
Chet Haasea1cff502012-02-21 13:43:44 -080012939 useDisplayListProperties &= hasDisplayList;
Chet Haase9420abd2012-03-29 16:28:32 -070012940 if (useDisplayListProperties) {
12941 displayList = getDisplayList();
12942 if (!displayList.isValid()) {
12943 // Uncommon, but possible. If a view is removed from the hierarchy during the call
12944 // to getDisplayList(), the display list will be marked invalid and we should not
12945 // try to use it again.
12946 displayList = null;
12947 hasDisplayList = false;
12948 useDisplayListProperties = false;
12949 }
12950 }
Chet Haase64a48c12012-02-13 16:33:29 -080012951
12952 final boolean hasNoCache = cache == null || hasDisplayList;
12953 final boolean offsetForScroll = cache == null && !hasDisplayList &&
12954 layerType != LAYER_TYPE_HARDWARE;
12955
Chet Haasea1cff502012-02-21 13:43:44 -080012956 int restoreTo = -1;
Chet Haase89b7f2e2012-03-21 11:15:37 -070012957 if (!useDisplayListProperties || transformToApply != null) {
Chet Haasea1cff502012-02-21 13:43:44 -080012958 restoreTo = canvas.save();
12959 }
Chet Haase64a48c12012-02-13 16:33:29 -080012960 if (offsetForScroll) {
Chet Haasebcca79a2012-02-14 08:45:14 -080012961 canvas.translate(mLeft - sx, mTop - sy);
Chet Haase64a48c12012-02-13 16:33:29 -080012962 } else {
Chet Haasea1cff502012-02-21 13:43:44 -080012963 if (!useDisplayListProperties) {
12964 canvas.translate(mLeft, mTop);
12965 }
Chet Haase64a48c12012-02-13 16:33:29 -080012966 if (scalingRequired) {
Chet Haasea1cff502012-02-21 13:43:44 -080012967 if (useDisplayListProperties) {
Chet Haase9420abd2012-03-29 16:28:32 -070012968 // TODO: Might not need this if we put everything inside the DL
Chet Haasea1cff502012-02-21 13:43:44 -080012969 restoreTo = canvas.save();
12970 }
Chet Haase64a48c12012-02-13 16:33:29 -080012971 // mAttachInfo cannot be null, otherwise scalingRequired == false
12972 final float scale = 1.0f / mAttachInfo.mApplicationScale;
12973 canvas.scale(scale, scale);
12974 }
12975 }
12976
Chet Haasea1cff502012-02-21 13:43:44 -080012977 float alpha = useDisplayListProperties ? 1 : getAlpha();
Chet Haase9420abd2012-03-29 16:28:32 -070012978 if (transformToApply != null || alpha < 1 || !hasIdentityMatrix()) {
Chet Haase64a48c12012-02-13 16:33:29 -080012979 if (transformToApply != null || !childHasIdentityMatrix) {
12980 int transX = 0;
12981 int transY = 0;
12982
12983 if (offsetForScroll) {
12984 transX = -sx;
12985 transY = -sy;
12986 }
12987
12988 if (transformToApply != null) {
12989 if (concatMatrix) {
Chet Haase9420abd2012-03-29 16:28:32 -070012990 if (useDisplayListProperties) {
12991 displayList.setAnimationMatrix(transformToApply.getMatrix());
12992 } else {
12993 // Undo the scroll translation, apply the transformation matrix,
12994 // then redo the scroll translate to get the correct result.
12995 canvas.translate(-transX, -transY);
12996 canvas.concat(transformToApply.getMatrix());
12997 canvas.translate(transX, transY);
12998 }
Chet Haasea1cff502012-02-21 13:43:44 -080012999 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080013000 }
13001
13002 float transformAlpha = transformToApply.getAlpha();
Chet Haase9420abd2012-03-29 16:28:32 -070013003 if (transformAlpha < 1) {
Chet Haase64a48c12012-02-13 16:33:29 -080013004 alpha *= transformToApply.getAlpha();
Chet Haasea1cff502012-02-21 13:43:44 -080013005 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080013006 }
13007 }
13008
Chet Haasea1cff502012-02-21 13:43:44 -080013009 if (!childHasIdentityMatrix && !useDisplayListProperties) {
Chet Haase64a48c12012-02-13 16:33:29 -080013010 canvas.translate(-transX, -transY);
13011 canvas.concat(getMatrix());
13012 canvas.translate(transX, transY);
13013 }
13014 }
13015
Chet Haase9420abd2012-03-29 16:28:32 -070013016 if (alpha < 1) {
Chet Haasea1cff502012-02-21 13:43:44 -080013017 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080013018 if (hasNoCache) {
13019 final int multipliedAlpha = (int) (255 * alpha);
13020 if (!onSetAlpha(multipliedAlpha)) {
13021 int layerFlags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
Chet Haasea1cff502012-02-21 13:43:44 -080013022 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) != 0 ||
Chet Haase64a48c12012-02-13 16:33:29 -080013023 layerType != LAYER_TYPE_NONE) {
13024 layerFlags |= Canvas.CLIP_TO_LAYER_SAVE_FLAG;
13025 }
Chet Haase9420abd2012-03-29 16:28:32 -070013026 if (useDisplayListProperties) {
13027 displayList.setAlpha(alpha * getAlpha());
13028 } else if (layerType == LAYER_TYPE_NONE) {
Chet Haase89b7f2e2012-03-21 11:15:37 -070013029 final int scrollX = hasDisplayList ? 0 : sx;
13030 final int scrollY = hasDisplayList ? 0 : sy;
13031 canvas.saveLayerAlpha(scrollX, scrollY, scrollX + mRight - mLeft,
13032 scrollY + mBottom - mTop, multipliedAlpha, layerFlags);
Chet Haase64a48c12012-02-13 16:33:29 -080013033 }
13034 } else {
13035 // Alpha is handled by the child directly, clobber the layer's alpha
13036 mPrivateFlags |= ALPHA_SET;
13037 }
13038 }
13039 }
13040 } else if ((mPrivateFlags & ALPHA_SET) == ALPHA_SET) {
13041 onSetAlpha(255);
13042 mPrivateFlags &= ~ALPHA_SET;
13043 }
13044
Chet Haasea1cff502012-02-21 13:43:44 -080013045 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) == ViewGroup.FLAG_CLIP_CHILDREN &&
13046 !useDisplayListProperties) {
Chet Haase64a48c12012-02-13 16:33:29 -080013047 if (offsetForScroll) {
Chet Haasebcca79a2012-02-14 08:45:14 -080013048 canvas.clipRect(sx, sy, sx + (mRight - mLeft), sy + (mBottom - mTop));
Chet Haase64a48c12012-02-13 16:33:29 -080013049 } else {
13050 if (!scalingRequired || cache == null) {
Chet Haasebcca79a2012-02-14 08:45:14 -080013051 canvas.clipRect(0, 0, mRight - mLeft, mBottom - mTop);
Chet Haase64a48c12012-02-13 16:33:29 -080013052 } else {
13053 canvas.clipRect(0, 0, cache.getWidth(), cache.getHeight());
13054 }
13055 }
13056 }
13057
Chet Haase9420abd2012-03-29 16:28:32 -070013058 if (!useDisplayListProperties && hasDisplayList) {
Chet Haase64a48c12012-02-13 16:33:29 -080013059 displayList = getDisplayList();
13060 if (!displayList.isValid()) {
13061 // Uncommon, but possible. If a view is removed from the hierarchy during the call
13062 // to getDisplayList(), the display list will be marked invalid and we should not
13063 // try to use it again.
13064 displayList = null;
13065 hasDisplayList = false;
13066 }
13067 }
13068
13069 if (hasNoCache) {
13070 boolean layerRendered = false;
Chet Haasea1cff502012-02-21 13:43:44 -080013071 if (layerType == LAYER_TYPE_HARDWARE && !useDisplayListProperties) {
Michael Jurka7e52caf2012-03-06 15:57:06 -080013072 final HardwareLayer layer = getHardwareLayer();
Chet Haase64a48c12012-02-13 16:33:29 -080013073 if (layer != null && layer.isValid()) {
13074 mLayerPaint.setAlpha((int) (alpha * 255));
13075 ((HardwareCanvas) canvas).drawHardwareLayer(layer, 0, 0, mLayerPaint);
13076 layerRendered = true;
13077 } else {
13078 final int scrollX = hasDisplayList ? 0 : sx;
13079 final int scrollY = hasDisplayList ? 0 : sy;
13080 canvas.saveLayer(scrollX, scrollY,
Chet Haasebcca79a2012-02-14 08:45:14 -080013081 scrollX + mRight - mLeft, scrollY + mBottom - mTop, mLayerPaint,
Chet Haase64a48c12012-02-13 16:33:29 -080013082 Canvas.HAS_ALPHA_LAYER_SAVE_FLAG | Canvas.CLIP_TO_LAYER_SAVE_FLAG);
13083 }
13084 }
13085
13086 if (!layerRendered) {
13087 if (!hasDisplayList) {
13088 // Fast path for layouts with no backgrounds
13089 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
13090 if (ViewDebug.TRACE_HIERARCHY) {
13091 ViewDebug.trace(parent, ViewDebug.HierarchyTraceType.DRAW);
13092 }
13093 mPrivateFlags &= ~DIRTY_MASK;
13094 dispatchDraw(canvas);
13095 } else {
13096 draw(canvas);
13097 }
13098 } else {
13099 mPrivateFlags &= ~DIRTY_MASK;
Chet Haase1271e2c2012-04-20 09:54:27 -070013100 ((HardwareCanvas) canvas).drawDisplayList(displayList, null, flags);
Chet Haase64a48c12012-02-13 16:33:29 -080013101 }
13102 }
13103 } else if (cache != null) {
13104 mPrivateFlags &= ~DIRTY_MASK;
13105 Paint cachePaint;
13106
13107 if (layerType == LAYER_TYPE_NONE) {
13108 cachePaint = parent.mCachePaint;
13109 if (cachePaint == null) {
13110 cachePaint = new Paint();
13111 cachePaint.setDither(false);
13112 parent.mCachePaint = cachePaint;
13113 }
Chet Haase9420abd2012-03-29 16:28:32 -070013114 if (alpha < 1) {
Chet Haase64a48c12012-02-13 16:33:29 -080013115 cachePaint.setAlpha((int) (alpha * 255));
Chet Haasea1cff502012-02-21 13:43:44 -080013116 parent.mGroupFlags |= ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE;
13117 } else if ((flags & ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE) != 0) {
Chet Haase64a48c12012-02-13 16:33:29 -080013118 cachePaint.setAlpha(255);
Chet Haasea1cff502012-02-21 13:43:44 -080013119 parent.mGroupFlags &= ~ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE;
Chet Haase64a48c12012-02-13 16:33:29 -080013120 }
13121 } else {
13122 cachePaint = mLayerPaint;
13123 cachePaint.setAlpha((int) (alpha * 255));
13124 }
13125 canvas.drawBitmap(cache, 0.0f, 0.0f, cachePaint);
13126 }
13127
Chet Haasea1cff502012-02-21 13:43:44 -080013128 if (restoreTo >= 0) {
13129 canvas.restoreToCount(restoreTo);
13130 }
Chet Haase64a48c12012-02-13 16:33:29 -080013131
13132 if (a != null && !more) {
13133 if (!hardwareAccelerated && !a.getFillAfter()) {
13134 onSetAlpha(255);
13135 }
13136 parent.finishAnimatingView(this, a);
13137 }
13138
13139 if (more && hardwareAccelerated) {
13140 // invalidation is the trigger to recreate display lists, so if we're using
13141 // display lists to render, force an invalidate to allow the animation to
13142 // continue drawing another frame
13143 parent.invalidate(true);
13144 if (a.hasAlpha() && (mPrivateFlags & ALPHA_SET) == ALPHA_SET) {
13145 // alpha animations should cause the child to recreate its display list
13146 invalidate(true);
13147 }
13148 }
13149
13150 mRecreateDisplayList = false;
13151
13152 return more;
13153 }
13154
13155 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013156 * Manually render this view (and all of its children) to the given Canvas.
13157 * The view must have already done a full layout before this function is
Romain Guy5c22a8c2011-05-13 11:48:45 -070013158 * called. When implementing a view, implement
13159 * {@link #onDraw(android.graphics.Canvas)} instead of overriding this method.
13160 * If you do need to override this method, call the superclass version.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013161 *
13162 * @param canvas The Canvas to which the View is rendered.
13163 */
13164 public void draw(Canvas canvas) {
13165 if (ViewDebug.TRACE_HIERARCHY) {
13166 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
13167 }
13168
Romain Guy5bcdff42009-05-14 21:27:18 -070013169 final int privateFlags = mPrivateFlags;
13170 final boolean dirtyOpaque = (privateFlags & DIRTY_MASK) == DIRTY_OPAQUE &&
13171 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState);
13172 mPrivateFlags = (privateFlags & ~DIRTY_MASK) | DRAWN;
Romain Guy24443ea2009-05-11 11:56:30 -070013173
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013174 /*
13175 * Draw traversal performs several drawing steps which must be executed
13176 * in the appropriate order:
13177 *
13178 * 1. Draw the background
13179 * 2. If necessary, save the canvas' layers to prepare for fading
13180 * 3. Draw view's content
13181 * 4. Draw children
13182 * 5. If necessary, draw the fading edges and restore layers
13183 * 6. Draw decorations (scrollbars for instance)
13184 */
13185
13186 // Step 1, draw the background, if needed
13187 int saveCount;
13188
Romain Guy24443ea2009-05-11 11:56:30 -070013189 if (!dirtyOpaque) {
Philip Milne6c8ea062012-04-03 17:38:43 -070013190 final Drawable background = mBackground;
Romain Guy24443ea2009-05-11 11:56:30 -070013191 if (background != null) {
13192 final int scrollX = mScrollX;
13193 final int scrollY = mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013194
Romain Guy24443ea2009-05-11 11:56:30 -070013195 if (mBackgroundSizeChanged) {
13196 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop);
13197 mBackgroundSizeChanged = false;
13198 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013199
Romain Guy24443ea2009-05-11 11:56:30 -070013200 if ((scrollX | scrollY) == 0) {
13201 background.draw(canvas);
13202 } else {
13203 canvas.translate(scrollX, scrollY);
13204 background.draw(canvas);
13205 canvas.translate(-scrollX, -scrollY);
13206 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013207 }
13208 }
13209
13210 // skip step 2 & 5 if possible (common case)
13211 final int viewFlags = mViewFlags;
13212 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0;
13213 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0;
13214 if (!verticalEdges && !horizontalEdges) {
13215 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -070013216 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013217
13218 // Step 4, draw the children
13219 dispatchDraw(canvas);
13220
13221 // Step 6, draw decorations (scrollbars)
13222 onDrawScrollBars(canvas);
13223
13224 // we're done...
13225 return;
13226 }
13227
13228 /*
13229 * Here we do the full fledged routine...
13230 * (this is an uncommon case where speed matters less,
13231 * this is why we repeat some of the tests that have been
13232 * done above)
13233 */
13234
13235 boolean drawTop = false;
13236 boolean drawBottom = false;
13237 boolean drawLeft = false;
13238 boolean drawRight = false;
13239
13240 float topFadeStrength = 0.0f;
13241 float bottomFadeStrength = 0.0f;
13242 float leftFadeStrength = 0.0f;
13243 float rightFadeStrength = 0.0f;
13244
13245 // Step 2, save the canvas' layers
13246 int paddingLeft = mPaddingLeft;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013247
13248 final boolean offsetRequired = isPaddingOffsetRequired();
13249 if (offsetRequired) {
13250 paddingLeft += getLeftPaddingOffset();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013251 }
13252
13253 int left = mScrollX + paddingLeft;
13254 int right = left + mRight - mLeft - mPaddingRight - paddingLeft;
Romain Guyf2fc4602011-07-19 15:20:03 -070013255 int top = mScrollY + getFadeTop(offsetRequired);
13256 int bottom = top + getFadeHeight(offsetRequired);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013257
13258 if (offsetRequired) {
13259 right += getRightPaddingOffset();
13260 bottom += getBottomPaddingOffset();
13261 }
13262
13263 final ScrollabilityCache scrollabilityCache = mScrollCache;
Philip Milne6c8ea062012-04-03 17:38:43 -070013264 final float fadeHeight = scrollabilityCache.fadingEdgeLength;
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013265 int length = (int) fadeHeight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013266
13267 // clip the fade length if top and bottom fades overlap
13268 // overlapping fades produce odd-looking artifacts
13269 if (verticalEdges && (top + length > bottom - length)) {
13270 length = (bottom - top) / 2;
13271 }
13272
13273 // also clip horizontal fades if necessary
13274 if (horizontalEdges && (left + length > right - length)) {
13275 length = (right - left) / 2;
13276 }
13277
13278 if (verticalEdges) {
13279 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013280 drawTop = topFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013281 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013282 drawBottom = bottomFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013283 }
13284
13285 if (horizontalEdges) {
13286 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013287 drawLeft = leftFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013288 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013289 drawRight = rightFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013290 }
13291
13292 saveCount = canvas.getSaveCount();
13293
13294 int solidColor = getSolidColor();
Romain Guyf607bdc2010-09-10 19:20:06 -070013295 if (solidColor == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013296 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
13297
13298 if (drawTop) {
13299 canvas.saveLayer(left, top, right, top + length, null, flags);
13300 }
13301
13302 if (drawBottom) {
13303 canvas.saveLayer(left, bottom - length, right, bottom, null, flags);
13304 }
13305
13306 if (drawLeft) {
13307 canvas.saveLayer(left, top, left + length, bottom, null, flags);
13308 }
13309
13310 if (drawRight) {
13311 canvas.saveLayer(right - length, top, right, bottom, null, flags);
13312 }
13313 } else {
13314 scrollabilityCache.setFadeColor(solidColor);
13315 }
13316
13317 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -070013318 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013319
13320 // Step 4, draw the children
13321 dispatchDraw(canvas);
13322
13323 // Step 5, draw the fade effect and restore layers
13324 final Paint p = scrollabilityCache.paint;
13325 final Matrix matrix = scrollabilityCache.matrix;
13326 final Shader fade = scrollabilityCache.shader;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013327
13328 if (drawTop) {
13329 matrix.setScale(1, fadeHeight * topFadeStrength);
13330 matrix.postTranslate(left, top);
13331 fade.setLocalMatrix(matrix);
13332 canvas.drawRect(left, top, right, top + length, p);
13333 }
13334
13335 if (drawBottom) {
13336 matrix.setScale(1, fadeHeight * bottomFadeStrength);
13337 matrix.postRotate(180);
13338 matrix.postTranslate(left, bottom);
13339 fade.setLocalMatrix(matrix);
13340 canvas.drawRect(left, bottom - length, right, bottom, p);
13341 }
13342
13343 if (drawLeft) {
13344 matrix.setScale(1, fadeHeight * leftFadeStrength);
13345 matrix.postRotate(-90);
13346 matrix.postTranslate(left, top);
13347 fade.setLocalMatrix(matrix);
13348 canvas.drawRect(left, top, left + length, bottom, p);
13349 }
13350
13351 if (drawRight) {
13352 matrix.setScale(1, fadeHeight * rightFadeStrength);
13353 matrix.postRotate(90);
13354 matrix.postTranslate(right, top);
13355 fade.setLocalMatrix(matrix);
13356 canvas.drawRect(right - length, top, right, bottom, p);
13357 }
13358
13359 canvas.restoreToCount(saveCount);
13360
13361 // Step 6, draw decorations (scrollbars)
13362 onDrawScrollBars(canvas);
13363 }
13364
13365 /**
13366 * Override this if your view is known to always be drawn on top of a solid color background,
13367 * and needs to draw fading edges. Returning a non-zero color enables the view system to
13368 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha
13369 * should be set to 0xFF.
13370 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013371 * @see #setVerticalFadingEdgeEnabled(boolean)
13372 * @see #setHorizontalFadingEdgeEnabled(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013373 *
13374 * @return The known solid color background for this view, or 0 if the color may vary
13375 */
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013376 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013377 public int getSolidColor() {
13378 return 0;
13379 }
13380
13381 /**
13382 * Build a human readable string representation of the specified view flags.
13383 *
13384 * @param flags the view flags to convert to a string
13385 * @return a String representing the supplied flags
13386 */
13387 private static String printFlags(int flags) {
13388 String output = "";
13389 int numFlags = 0;
13390 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) {
13391 output += "TAKES_FOCUS";
13392 numFlags++;
13393 }
13394
13395 switch (flags & VISIBILITY_MASK) {
13396 case INVISIBLE:
13397 if (numFlags > 0) {
13398 output += " ";
13399 }
13400 output += "INVISIBLE";
13401 // USELESS HERE numFlags++;
13402 break;
13403 case GONE:
13404 if (numFlags > 0) {
13405 output += " ";
13406 }
13407 output += "GONE";
13408 // USELESS HERE numFlags++;
13409 break;
13410 default:
13411 break;
13412 }
13413 return output;
13414 }
13415
13416 /**
13417 * Build a human readable string representation of the specified private
13418 * view flags.
13419 *
13420 * @param privateFlags the private view flags to convert to a string
13421 * @return a String representing the supplied flags
13422 */
13423 private static String printPrivateFlags(int privateFlags) {
13424 String output = "";
13425 int numFlags = 0;
13426
13427 if ((privateFlags & WANTS_FOCUS) == WANTS_FOCUS) {
13428 output += "WANTS_FOCUS";
13429 numFlags++;
13430 }
13431
13432 if ((privateFlags & FOCUSED) == FOCUSED) {
13433 if (numFlags > 0) {
13434 output += " ";
13435 }
13436 output += "FOCUSED";
13437 numFlags++;
13438 }
13439
13440 if ((privateFlags & SELECTED) == SELECTED) {
13441 if (numFlags > 0) {
13442 output += " ";
13443 }
13444 output += "SELECTED";
13445 numFlags++;
13446 }
13447
13448 if ((privateFlags & IS_ROOT_NAMESPACE) == IS_ROOT_NAMESPACE) {
13449 if (numFlags > 0) {
13450 output += " ";
13451 }
13452 output += "IS_ROOT_NAMESPACE";
13453 numFlags++;
13454 }
13455
13456 if ((privateFlags & HAS_BOUNDS) == HAS_BOUNDS) {
13457 if (numFlags > 0) {
13458 output += " ";
13459 }
13460 output += "HAS_BOUNDS";
13461 numFlags++;
13462 }
13463
13464 if ((privateFlags & DRAWN) == DRAWN) {
13465 if (numFlags > 0) {
13466 output += " ";
13467 }
13468 output += "DRAWN";
13469 // USELESS HERE numFlags++;
13470 }
13471 return output;
13472 }
13473
13474 /**
13475 * <p>Indicates whether or not this view's layout will be requested during
13476 * the next hierarchy layout pass.</p>
13477 *
13478 * @return true if the layout will be forced during next layout pass
13479 */
13480 public boolean isLayoutRequested() {
13481 return (mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT;
13482 }
13483
13484 /**
13485 * Assign a size and position to a view and all of its
13486 * descendants
13487 *
13488 * <p>This is the second phase of the layout mechanism.
13489 * (The first is measuring). In this phase, each parent calls
13490 * layout on all of its children to position them.
13491 * This is typically done using the child measurements
Chet Haase9c087442011-01-12 16:20:16 -080013492 * that were stored in the measure pass().</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013493 *
Chet Haase9c087442011-01-12 16:20:16 -080013494 * <p>Derived classes should not override this method.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013495 * Derived classes with children should override
13496 * onLayout. In that method, they should
Chet Haase9c087442011-01-12 16:20:16 -080013497 * call layout on each of their children.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013498 *
13499 * @param l Left position, relative to parent
13500 * @param t Top position, relative to parent
13501 * @param r Right position, relative to parent
13502 * @param b Bottom position, relative to parent
13503 */
Romain Guy5429e1d2010-09-07 12:38:00 -070013504 @SuppressWarnings({"unchecked"})
Chet Haase9c087442011-01-12 16:20:16 -080013505 public void layout(int l, int t, int r, int b) {
Chet Haase21cd1382010-09-01 17:42:29 -070013506 int oldL = mLeft;
13507 int oldT = mTop;
13508 int oldB = mBottom;
13509 int oldR = mRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013510 boolean changed = setFrame(l, t, r, b);
13511 if (changed || (mPrivateFlags & LAYOUT_REQUIRED) == LAYOUT_REQUIRED) {
13512 if (ViewDebug.TRACE_HIERARCHY) {
13513 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_LAYOUT);
13514 }
13515
13516 onLayout(changed, l, t, r, b);
13517 mPrivateFlags &= ~LAYOUT_REQUIRED;
Chet Haase21cd1382010-09-01 17:42:29 -070013518
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070013519 ListenerInfo li = mListenerInfo;
13520 if (li != null && li.mOnLayoutChangeListeners != null) {
Chet Haase21cd1382010-09-01 17:42:29 -070013521 ArrayList<OnLayoutChangeListener> listenersCopy =
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070013522 (ArrayList<OnLayoutChangeListener>)li.mOnLayoutChangeListeners.clone();
Chet Haase21cd1382010-09-01 17:42:29 -070013523 int numListeners = listenersCopy.size();
13524 for (int i = 0; i < numListeners; ++i) {
Chet Haase7c608f22010-10-22 17:54:04 -070013525 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB);
Chet Haase21cd1382010-09-01 17:42:29 -070013526 }
13527 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013528 }
13529 mPrivateFlags &= ~FORCE_LAYOUT;
13530 }
13531
13532 /**
13533 * Called from layout when this view should
13534 * assign a size and position to each of its children.
13535 *
13536 * Derived classes with children should override
13537 * this method and call layout on each of
Chet Haase21cd1382010-09-01 17:42:29 -070013538 * their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013539 * @param changed This is a new size or position for this view
13540 * @param left Left position, relative to parent
13541 * @param top Top position, relative to parent
13542 * @param right Right position, relative to parent
13543 * @param bottom Bottom position, relative to parent
13544 */
13545 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
13546 }
13547
13548 /**
13549 * Assign a size and position to this view.
13550 *
13551 * This is called from layout.
13552 *
13553 * @param left Left position, relative to parent
13554 * @param top Top position, relative to parent
13555 * @param right Right position, relative to parent
13556 * @param bottom Bottom position, relative to parent
13557 * @return true if the new size and position are different than the
13558 * previous ones
13559 * {@hide}
13560 */
13561 protected boolean setFrame(int left, int top, int right, int bottom) {
13562 boolean changed = false;
13563
13564 if (DBG) {
Mitsuru Oshima64f59342009-06-21 00:03:11 -070013565 Log.d("View", this + " View.setFrame(" + left + "," + top + ","
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013566 + right + "," + bottom + ")");
13567 }
13568
13569 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) {
13570 changed = true;
13571
13572 // Remember our drawn bit
13573 int drawn = mPrivateFlags & DRAWN;
13574
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013575 int oldWidth = mRight - mLeft;
13576 int oldHeight = mBottom - mTop;
Chet Haase75755e22011-07-18 17:48:25 -070013577 int newWidth = right - left;
13578 int newHeight = bottom - top;
13579 boolean sizeChanged = (newWidth != oldWidth) || (newHeight != oldHeight);
13580
13581 // Invalidate our old position
13582 invalidate(sizeChanged);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013583
13584 mLeft = left;
13585 mTop = top;
13586 mRight = right;
13587 mBottom = bottom;
Chet Haase1271e2c2012-04-20 09:54:27 -070013588 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -080013589 mDisplayList.setLeftTopRightBottom(mLeft, mTop, mRight, mBottom);
13590 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013591
13592 mPrivateFlags |= HAS_BOUNDS;
13593
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013594
Chet Haase75755e22011-07-18 17:48:25 -070013595 if (sizeChanged) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -080013596 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
13597 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -070013598 if (mTransformationInfo != null) {
13599 mTransformationInfo.mMatrixDirty = true;
13600 }
Chet Haase6c7ad5d2010-12-28 08:40:00 -080013601 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013602 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight);
13603 }
13604
13605 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) {
13606 // If we are visible, force the DRAWN bit to on so that
13607 // this invalidate will go through (at least to our parent).
13608 // This is because someone may have invalidated this view
Chet Haase6c7ad5d2010-12-28 08:40:00 -080013609 // before this call to setFrame came in, thereby clearing
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013610 // the DRAWN bit.
13611 mPrivateFlags |= DRAWN;
Chet Haase75755e22011-07-18 17:48:25 -070013612 invalidate(sizeChanged);
Chet Haasef28595e2011-01-31 18:52:12 -080013613 // parent display list may need to be recreated based on a change in the bounds
13614 // of any child
13615 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013616 }
13617
13618 // Reset drawn bit to original value (invalidate turns it off)
13619 mPrivateFlags |= drawn;
13620
13621 mBackgroundSizeChanged = true;
13622 }
13623 return changed;
13624 }
13625
13626 /**
13627 * Finalize inflating a view from XML. This is called as the last phase
13628 * of inflation, after all child views have been added.
13629 *
13630 * <p>Even if the subclass overrides onFinishInflate, they should always be
13631 * sure to call the super method, so that we get called.
13632 */
13633 protected void onFinishInflate() {
13634 }
13635
13636 /**
13637 * Returns the resources associated with this view.
13638 *
13639 * @return Resources object.
13640 */
13641 public Resources getResources() {
13642 return mResources;
13643 }
13644
13645 /**
13646 * Invalidates the specified Drawable.
13647 *
13648 * @param drawable the drawable to invalidate
13649 */
13650 public void invalidateDrawable(Drawable drawable) {
13651 if (verifyDrawable(drawable)) {
13652 final Rect dirty = drawable.getBounds();
13653 final int scrollX = mScrollX;
13654 final int scrollY = mScrollY;
13655
13656 invalidate(dirty.left + scrollX, dirty.top + scrollY,
13657 dirty.right + scrollX, dirty.bottom + scrollY);
13658 }
13659 }
13660
13661 /**
13662 * Schedules an action on a drawable to occur at a specified time.
13663 *
13664 * @param who the recipient of the action
13665 * @param what the action to run on the drawable
13666 * @param when the time at which the action must occur. Uses the
13667 * {@link SystemClock#uptimeMillis} timebase.
13668 */
13669 public void scheduleDrawable(Drawable who, Runnable what, long when) {
Adam Powell37419d72011-11-10 11:32:09 -080013670 if (verifyDrawable(who) && what != null) {
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080013671 final long delay = when - SystemClock.uptimeMillis();
Adam Powell37419d72011-11-10 11:32:09 -080013672 if (mAttachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070013673 mAttachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed(
13674 Choreographer.CALLBACK_ANIMATION, what, who,
13675 Choreographer.subtractFrameDelay(delay));
Adam Powell37419d72011-11-10 11:32:09 -080013676 } else {
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080013677 ViewRootImpl.getRunQueue().postDelayed(what, delay);
Adam Powell37419d72011-11-10 11:32:09 -080013678 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013679 }
13680 }
13681
13682 /**
13683 * Cancels a scheduled action on a drawable.
13684 *
13685 * @param who the recipient of the action
13686 * @param what the action to cancel
13687 */
13688 public void unscheduleDrawable(Drawable who, Runnable what) {
Adam Powell37419d72011-11-10 11:32:09 -080013689 if (verifyDrawable(who) && what != null) {
13690 if (mAttachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070013691 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks(
13692 Choreographer.CALLBACK_ANIMATION, what, who);
Adam Powell37419d72011-11-10 11:32:09 -080013693 } else {
13694 ViewRootImpl.getRunQueue().removeCallbacks(what);
13695 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013696 }
13697 }
13698
13699 /**
13700 * Unschedule any events associated with the given Drawable. This can be
13701 * used when selecting a new Drawable into a view, so that the previous
13702 * one is completely unscheduled.
13703 *
13704 * @param who The Drawable to unschedule.
13705 *
13706 * @see #drawableStateChanged
13707 */
13708 public void unscheduleDrawable(Drawable who) {
Jeff Brown43ea54b2012-03-09 14:37:48 -080013709 if (mAttachInfo != null && who != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070013710 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks(
13711 Choreographer.CALLBACK_ANIMATION, null, who);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013712 }
13713 }
13714
Fabrice Di Meglioc0053222011-06-13 12:16:51 -070013715 /**
13716 * Return the layout direction of a given Drawable.
13717 *
13718 * @param who the Drawable to query
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070013719 * @hide
Fabrice Di Meglioc0053222011-06-13 12:16:51 -070013720 */
13721 public int getResolvedLayoutDirection(Drawable who) {
Philip Milne6c8ea062012-04-03 17:38:43 -070013722 return (who == mBackground) ? getResolvedLayoutDirection() : LAYOUT_DIRECTION_DEFAULT;
Fabrice Di Meglio6a036402011-05-23 14:43:23 -070013723 }
13724
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013725 /**
13726 * If your view subclass is displaying its own Drawable objects, it should
13727 * override this function and return true for any Drawable it is
13728 * displaying. This allows animations for those drawables to be
13729 * scheduled.
13730 *
13731 * <p>Be sure to call through to the super class when overriding this
13732 * function.
13733 *
13734 * @param who The Drawable to verify. Return true if it is one you are
13735 * displaying, else return the result of calling through to the
13736 * super class.
13737 *
13738 * @return boolean If true than the Drawable is being displayed in the
13739 * view; else false and it is not allowed to animate.
13740 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013741 * @see #unscheduleDrawable(android.graphics.drawable.Drawable)
13742 * @see #drawableStateChanged()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013743 */
13744 protected boolean verifyDrawable(Drawable who) {
Philip Milne6c8ea062012-04-03 17:38:43 -070013745 return who == mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013746 }
13747
13748 /**
13749 * This function is called whenever the state of the view changes in such
13750 * a way that it impacts the state of drawables being shown.
13751 *
13752 * <p>Be sure to call through to the superclass when overriding this
13753 * function.
13754 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013755 * @see Drawable#setState(int[])
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013756 */
13757 protected void drawableStateChanged() {
Philip Milne6c8ea062012-04-03 17:38:43 -070013758 Drawable d = mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013759 if (d != null && d.isStateful()) {
13760 d.setState(getDrawableState());
13761 }
13762 }
13763
13764 /**
13765 * Call this to force a view to update its drawable state. This will cause
13766 * drawableStateChanged to be called on this view. Views that are interested
13767 * in the new state should call getDrawableState.
13768 *
13769 * @see #drawableStateChanged
13770 * @see #getDrawableState
13771 */
13772 public void refreshDrawableState() {
13773 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
13774 drawableStateChanged();
13775
13776 ViewParent parent = mParent;
13777 if (parent != null) {
13778 parent.childDrawableStateChanged(this);
13779 }
13780 }
13781
13782 /**
13783 * Return an array of resource IDs of the drawable states representing the
13784 * current state of the view.
13785 *
13786 * @return The current drawable state
13787 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013788 * @see Drawable#setState(int[])
13789 * @see #drawableStateChanged()
13790 * @see #onCreateDrawableState(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013791 */
13792 public final int[] getDrawableState() {
13793 if ((mDrawableState != null) && ((mPrivateFlags & DRAWABLE_STATE_DIRTY) == 0)) {
13794 return mDrawableState;
13795 } else {
13796 mDrawableState = onCreateDrawableState(0);
13797 mPrivateFlags &= ~DRAWABLE_STATE_DIRTY;
13798 return mDrawableState;
13799 }
13800 }
13801
13802 /**
13803 * Generate the new {@link android.graphics.drawable.Drawable} state for
13804 * this view. This is called by the view
13805 * system when the cached Drawable state is determined to be invalid. To
13806 * retrieve the current state, you should use {@link #getDrawableState}.
13807 *
13808 * @param extraSpace if non-zero, this is the number of extra entries you
13809 * would like in the returned array in which you can place your own
13810 * states.
13811 *
13812 * @return Returns an array holding the current {@link Drawable} state of
13813 * the view.
13814 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013815 * @see #mergeDrawableStates(int[], int[])
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013816 */
13817 protected int[] onCreateDrawableState(int extraSpace) {
13818 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE &&
13819 mParent instanceof View) {
13820 return ((View) mParent).onCreateDrawableState(extraSpace);
13821 }
13822
13823 int[] drawableState;
13824
13825 int privateFlags = mPrivateFlags;
13826
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070013827 int viewStateIndex = 0;
13828 if ((privateFlags & PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED;
13829 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED;
13830 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED;
Neel Parekhe5378582010-10-06 11:36:50 -070013831 if ((privateFlags & SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070013832 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED;
13833 if ((privateFlags & ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED;
Adam Powell5a7e94e2011-04-25 15:30:43 -070013834 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested &&
13835 HardwareRenderer.isAvailable()) {
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080013836 // This is set if HW acceleration is requested, even if the current
13837 // process doesn't allow it. This is just to allow app preview
13838 // windows to better match their app.
13839 viewStateIndex |= VIEW_STATE_ACCELERATED;
13840 }
PY Laligandc33d8d49e2011-03-14 18:22:53 -070013841 if ((privateFlags & HOVERED) != 0) viewStateIndex |= VIEW_STATE_HOVERED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013842
Christopher Tate3d4bf172011-03-28 16:16:46 -070013843 final int privateFlags2 = mPrivateFlags2;
13844 if ((privateFlags2 & DRAG_CAN_ACCEPT) != 0) viewStateIndex |= VIEW_STATE_DRAG_CAN_ACCEPT;
13845 if ((privateFlags2 & DRAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_DRAG_HOVERED;
13846
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013847 drawableState = VIEW_STATE_SETS[viewStateIndex];
13848
13849 //noinspection ConstantIfStatement
13850 if (false) {
13851 Log.i("View", "drawableStateIndex=" + viewStateIndex);
13852 Log.i("View", toString()
13853 + " pressed=" + ((privateFlags & PRESSED) != 0)
13854 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED)
13855 + " fo=" + hasFocus()
13856 + " sl=" + ((privateFlags & SELECTED) != 0)
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070013857 + " wf=" + hasWindowFocus()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013858 + ": " + Arrays.toString(drawableState));
13859 }
13860
13861 if (extraSpace == 0) {
13862 return drawableState;
13863 }
13864
13865 final int[] fullState;
13866 if (drawableState != null) {
13867 fullState = new int[drawableState.length + extraSpace];
13868 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length);
13869 } else {
13870 fullState = new int[extraSpace];
13871 }
13872
13873 return fullState;
13874 }
13875
13876 /**
13877 * Merge your own state values in <var>additionalState</var> into the base
13878 * state values <var>baseState</var> that were returned by
Romain Guy5c22a8c2011-05-13 11:48:45 -070013879 * {@link #onCreateDrawableState(int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013880 *
13881 * @param baseState The base state values returned by
Romain Guy5c22a8c2011-05-13 11:48:45 -070013882 * {@link #onCreateDrawableState(int)}, which will be modified to also hold your
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013883 * own additional state values.
13884 *
13885 * @param additionalState The additional state values you would like
13886 * added to <var>baseState</var>; this array is not modified.
13887 *
13888 * @return As a convenience, the <var>baseState</var> array you originally
13889 * passed into the function is returned.
13890 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013891 * @see #onCreateDrawableState(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013892 */
13893 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) {
13894 final int N = baseState.length;
13895 int i = N - 1;
13896 while (i >= 0 && baseState[i] == 0) {
13897 i--;
13898 }
13899 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length);
13900 return baseState;
13901 }
13902
13903 /**
Dianne Hackborn079e2352010-10-18 17:02:43 -070013904 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()}
13905 * on all Drawable objects associated with this view.
13906 */
13907 public void jumpDrawablesToCurrentState() {
Philip Milne6c8ea062012-04-03 17:38:43 -070013908 if (mBackground != null) {
13909 mBackground.jumpToCurrentState();
Dianne Hackborn079e2352010-10-18 17:02:43 -070013910 }
13911 }
13912
13913 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013914 * Sets the background color for this view.
13915 * @param color the color of the background
13916 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +000013917 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013918 public void setBackgroundColor(int color) {
Philip Milne6c8ea062012-04-03 17:38:43 -070013919 if (mBackground instanceof ColorDrawable) {
13920 ((ColorDrawable) mBackground).setColor(color);
Chet Haase70d4ba12010-10-06 09:46:45 -070013921 } else {
Philip Milne6c8ea062012-04-03 17:38:43 -070013922 setBackground(new ColorDrawable(color));
Chet Haase70d4ba12010-10-06 09:46:45 -070013923 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013924 }
13925
13926 /**
13927 * Set the background to a given resource. The resource should refer to
Wink Saville7cd88e12009-08-04 14:45:10 -070013928 * a Drawable object or 0 to remove the background.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013929 * @param resid The identifier of the resource.
Philip Milne6c8ea062012-04-03 17:38:43 -070013930 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013931 * @attr ref android.R.styleable#View_background
13932 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +000013933 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013934 public void setBackgroundResource(int resid) {
13935 if (resid != 0 && resid == mBackgroundResource) {
13936 return;
13937 }
13938
13939 Drawable d= null;
13940 if (resid != 0) {
13941 d = mResources.getDrawable(resid);
13942 }
Philip Milne6c8ea062012-04-03 17:38:43 -070013943 setBackground(d);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013944
13945 mBackgroundResource = resid;
13946 }
13947
13948 /**
13949 * Set the background to a given Drawable, or remove the background. If the
13950 * background has padding, this View's padding is set to the background's
13951 * padding. However, when a background is removed, this View's padding isn't
13952 * touched. If setting the padding is desired, please use
13953 * {@link #setPadding(int, int, int, int)}.
13954 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013955 * @param background The Drawable to use as the background, or null to remove the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013956 * background
13957 */
Philip Milne6c8ea062012-04-03 17:38:43 -070013958 public void setBackground(Drawable background) {
Romain Guyeb378892012-04-12 11:33:14 -070013959 //noinspection deprecation
Philip Milne6c8ea062012-04-03 17:38:43 -070013960 setBackgroundDrawable(background);
13961 }
13962
13963 /**
13964 * @deprecated use {@link #setBackground(Drawable)} instead
13965 */
13966 @Deprecated
13967 public void setBackgroundDrawable(Drawable background) {
13968 if (background == mBackground) {
Adam Powell4d36ec12011-07-17 16:44:16 -070013969 return;
13970 }
13971
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013972 boolean requestLayout = false;
13973
13974 mBackgroundResource = 0;
13975
13976 /*
13977 * Regardless of whether we're setting a new background or not, we want
13978 * to clear the previous drawable.
13979 */
Philip Milne6c8ea062012-04-03 17:38:43 -070013980 if (mBackground != null) {
13981 mBackground.setCallback(null);
13982 unscheduleDrawable(mBackground);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013983 }
13984
Philip Milne6c8ea062012-04-03 17:38:43 -070013985 if (background != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013986 Rect padding = sThreadLocal.get();
13987 if (padding == null) {
13988 padding = new Rect();
13989 sThreadLocal.set(padding);
13990 }
Philip Milne6c8ea062012-04-03 17:38:43 -070013991 if (background.getPadding(padding)) {
13992 switch (background.getResolvedLayoutDirectionSelf()) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070013993 case LAYOUT_DIRECTION_RTL:
13994 setPadding(padding.right, padding.top, padding.left, padding.bottom);
13995 break;
13996 case LAYOUT_DIRECTION_LTR:
13997 default:
13998 setPadding(padding.left, padding.top, padding.right, padding.bottom);
13999 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014000 }
14001
14002 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or
14003 // if it has a different minimum size, we should layout again
Philip Milne6c8ea062012-04-03 17:38:43 -070014004 if (mBackground == null || mBackground.getMinimumHeight() != background.getMinimumHeight() ||
14005 mBackground.getMinimumWidth() != background.getMinimumWidth()) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014006 requestLayout = true;
14007 }
14008
Philip Milne6c8ea062012-04-03 17:38:43 -070014009 background.setCallback(this);
14010 if (background.isStateful()) {
14011 background.setState(getDrawableState());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014012 }
Philip Milne6c8ea062012-04-03 17:38:43 -070014013 background.setVisible(getVisibility() == VISIBLE, false);
14014 mBackground = background;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014015
14016 if ((mPrivateFlags & SKIP_DRAW) != 0) {
14017 mPrivateFlags &= ~SKIP_DRAW;
14018 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
14019 requestLayout = true;
14020 }
14021 } else {
14022 /* Remove the background */
Philip Milne6c8ea062012-04-03 17:38:43 -070014023 mBackground = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014024
14025 if ((mPrivateFlags & ONLY_DRAWS_BACKGROUND) != 0) {
14026 /*
14027 * This view ONLY drew the background before and we're removing
14028 * the background, so now it won't draw anything
14029 * (hence we SKIP_DRAW)
14030 */
14031 mPrivateFlags &= ~ONLY_DRAWS_BACKGROUND;
14032 mPrivateFlags |= SKIP_DRAW;
14033 }
14034
14035 /*
14036 * When the background is set, we try to apply its padding to this
14037 * View. When the background is removed, we don't touch this View's
14038 * padding. This is noted in the Javadocs. Hence, we don't need to
14039 * requestLayout(), the invalidate() below is sufficient.
14040 */
14041
14042 // The old background's minimum size could have affected this
14043 // View's layout, so let's requestLayout
14044 requestLayout = true;
14045 }
14046
Romain Guy8f1344f52009-05-15 16:03:59 -070014047 computeOpaqueFlags();
14048
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014049 if (requestLayout) {
14050 requestLayout();
14051 }
14052
14053 mBackgroundSizeChanged = true;
Romain Guy0fd89bf2011-01-26 15:41:30 -080014054 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014055 }
14056
14057 /**
14058 * Gets the background drawable
Philip Milne6c8ea062012-04-03 17:38:43 -070014059 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014060 * @return The drawable used as the background for this view, if any.
Philip Milne6c8ea062012-04-03 17:38:43 -070014061 *
14062 * @see #setBackground(Drawable)
14063 *
14064 * @attr ref android.R.styleable#View_background
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014065 */
14066 public Drawable getBackground() {
Philip Milne6c8ea062012-04-03 17:38:43 -070014067 return mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014068 }
14069
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014070 /**
14071 * Sets the padding. The view may add on the space required to display
14072 * the scrollbars, depending on the style and visibility of the scrollbars.
14073 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop},
14074 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different
14075 * from the values set in this call.
14076 *
14077 * @attr ref android.R.styleable#View_padding
14078 * @attr ref android.R.styleable#View_paddingBottom
14079 * @attr ref android.R.styleable#View_paddingLeft
14080 * @attr ref android.R.styleable#View_paddingRight
14081 * @attr ref android.R.styleable#View_paddingTop
14082 * @param left the left padding in pixels
14083 * @param top the top padding in pixels
14084 * @param right the right padding in pixels
14085 * @param bottom the bottom padding in pixels
14086 */
14087 public void setPadding(int left, int top, int right, int bottom) {
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014088 mUserPaddingStart = -1;
14089 mUserPaddingEnd = -1;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014090 mUserPaddingRelative = false;
14091
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014092 internalSetPadding(left, top, right, bottom);
14093 }
14094
14095 private void internalSetPadding(int left, int top, int right, int bottom) {
Adam Powell20232d02010-12-08 21:08:53 -080014096 mUserPaddingLeft = left;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014097 mUserPaddingRight = right;
14098 mUserPaddingBottom = bottom;
14099
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014100 final int viewFlags = mViewFlags;
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014101 boolean changed = false;
Romain Guy8506ab42009-06-11 17:35:47 -070014102
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014103 // Common case is there are no scroll bars.
14104 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014105 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) {
Adam Powell20232d02010-12-08 21:08:53 -080014106 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014107 ? 0 : getVerticalScrollbarWidth();
Adam Powell20232d02010-12-08 21:08:53 -080014108 switch (mVerticalScrollbarPosition) {
14109 case SCROLLBAR_POSITION_DEFAULT:
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014110 if (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) {
14111 left += offset;
14112 } else {
14113 right += offset;
14114 }
14115 break;
Adam Powell20232d02010-12-08 21:08:53 -080014116 case SCROLLBAR_POSITION_RIGHT:
14117 right += offset;
14118 break;
14119 case SCROLLBAR_POSITION_LEFT:
14120 left += offset;
14121 break;
14122 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014123 }
Adam Powell20232d02010-12-08 21:08:53 -080014124 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014125 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0
14126 ? 0 : getHorizontalScrollbarHeight();
14127 }
14128 }
Romain Guy8506ab42009-06-11 17:35:47 -070014129
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014130 if (mPaddingLeft != left) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014131 changed = true;
14132 mPaddingLeft = left;
14133 }
14134 if (mPaddingTop != top) {
14135 changed = true;
14136 mPaddingTop = top;
14137 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014138 if (mPaddingRight != right) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014139 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014140 mPaddingRight = right;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014141 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014142 if (mPaddingBottom != bottom) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014143 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014144 mPaddingBottom = bottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014145 }
14146
14147 if (changed) {
14148 requestLayout();
14149 }
14150 }
14151
14152 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014153 * Sets the relative padding. The view may add on the space required to display
14154 * the scrollbars, depending on the style and visibility of the scrollbars.
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014155 * from the values set in this call.
14156 *
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014157 * @param start the start padding in pixels
14158 * @param top the top padding in pixels
14159 * @param end the end padding in pixels
14160 * @param bottom the bottom padding in pixels
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014161 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014162 */
14163 public void setPaddingRelative(int start, int top, int end, int bottom) {
Fabrice Di Megliof9e36502011-06-21 18:41:48 -070014164 mUserPaddingStart = start;
14165 mUserPaddingEnd = end;
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014166 mUserPaddingRelative = true;
Fabrice Di Megliof9e36502011-06-21 18:41:48 -070014167
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014168 switch(getResolvedLayoutDirection()) {
14169 case LAYOUT_DIRECTION_RTL:
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014170 internalSetPadding(end, top, start, bottom);
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014171 break;
14172 case LAYOUT_DIRECTION_LTR:
14173 default:
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014174 internalSetPadding(start, top, end, bottom);
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014175 }
14176 }
14177
14178 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014179 * Returns the top padding of this view.
14180 *
14181 * @return the top padding in pixels
14182 */
14183 public int getPaddingTop() {
14184 return mPaddingTop;
14185 }
14186
14187 /**
14188 * Returns the bottom padding of this view. If there are inset and enabled
14189 * scrollbars, this value may include the space required to display the
14190 * scrollbars as well.
14191 *
14192 * @return the bottom padding in pixels
14193 */
14194 public int getPaddingBottom() {
14195 return mPaddingBottom;
14196 }
14197
14198 /**
14199 * Returns the left padding of this view. If there are inset and enabled
14200 * scrollbars, this value may include the space required to display the
14201 * scrollbars as well.
14202 *
14203 * @return the left padding in pixels
14204 */
14205 public int getPaddingLeft() {
14206 return mPaddingLeft;
14207 }
14208
14209 /**
Fabrice Di Meglio30a21e12012-03-12 13:12:19 -070014210 * Returns the start padding of this view depending on its resolved layout direction.
14211 * If there are inset and enabled scrollbars, this value may include the space
14212 * required to display the scrollbars as well.
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014213 *
14214 * @return the start padding in pixels
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014215 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014216 */
14217 public int getPaddingStart() {
14218 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) ?
14219 mPaddingRight : mPaddingLeft;
14220 }
14221
14222 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014223 * Returns the right padding of this view. If there are inset and enabled
14224 * scrollbars, this value may include the space required to display the
14225 * scrollbars as well.
14226 *
14227 * @return the right padding in pixels
14228 */
14229 public int getPaddingRight() {
14230 return mPaddingRight;
14231 }
14232
14233 /**
Fabrice Di Meglio30a21e12012-03-12 13:12:19 -070014234 * Returns the end padding of this view depending on its resolved layout direction.
14235 * If there are inset and enabled scrollbars, this value may include the space
14236 * required to display the scrollbars as well.
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014237 *
14238 * @return the end padding in pixels
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014239 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014240 */
14241 public int getPaddingEnd() {
14242 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) ?
14243 mPaddingLeft : mPaddingRight;
14244 }
14245
14246 /**
14247 * Return if the padding as been set thru relative values
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014248 * {@link #setPaddingRelative(int, int, int, int)}
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014249 *
14250 * @return true if the padding is relative or false if it is not.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014251 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014252 */
14253 public boolean isPaddingRelative() {
14254 return mUserPaddingRelative;
14255 }
14256
14257 /**
Philip Milne1557fd72012-04-04 23:41:34 -070014258 * @hide
14259 */
Philip Milne7a23b492012-04-24 22:12:36 -070014260 public Insets getOpticalInsets() {
Philip Milne1557fd72012-04-04 23:41:34 -070014261 if (mLayoutInsets == null) {
Philip Milnebbd51f12012-04-18 15:09:05 -070014262 mLayoutInsets = (mBackground == null) ? Insets.NONE : mBackground.getLayoutInsets();
Philip Milne1557fd72012-04-04 23:41:34 -070014263 }
14264 return mLayoutInsets;
14265 }
14266
14267 /**
14268 * @hide
14269 */
14270 public void setLayoutInsets(Insets layoutInsets) {
14271 mLayoutInsets = layoutInsets;
14272 }
14273
14274 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014275 * Changes the selection state of this view. A view can be selected or not.
14276 * Note that selection is not the same as focus. Views are typically
14277 * selected in the context of an AdapterView like ListView or GridView;
14278 * the selected view is the view that is highlighted.
14279 *
14280 * @param selected true if the view must be selected, false otherwise
14281 */
14282 public void setSelected(boolean selected) {
14283 if (((mPrivateFlags & SELECTED) != 0) != selected) {
14284 mPrivateFlags = (mPrivateFlags & ~SELECTED) | (selected ? SELECTED : 0);
Romain Guya2431d02009-04-30 16:30:00 -070014285 if (!selected) resetPressedState();
Romain Guy0fd89bf2011-01-26 15:41:30 -080014286 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014287 refreshDrawableState();
14288 dispatchSetSelected(selected);
Svetoslav Ganov42138042012-03-20 11:51:39 -070014289 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
14290 notifyAccessibilityStateChanged();
14291 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014292 }
14293 }
14294
14295 /**
14296 * Dispatch setSelected to all of this View's children.
14297 *
14298 * @see #setSelected(boolean)
14299 *
14300 * @param selected The new selected state
14301 */
14302 protected void dispatchSetSelected(boolean selected) {
14303 }
14304
14305 /**
14306 * Indicates the selection state of this view.
14307 *
14308 * @return true if the view is selected, false otherwise
14309 */
14310 @ViewDebug.ExportedProperty
14311 public boolean isSelected() {
14312 return (mPrivateFlags & SELECTED) != 0;
14313 }
14314
14315 /**
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014316 * Changes the activated state of this view. A view can be activated or not.
14317 * Note that activation is not the same as selection. Selection is
14318 * a transient property, representing the view (hierarchy) the user is
14319 * currently interacting with. Activation is a longer-term state that the
14320 * user can move views in and out of. For example, in a list view with
14321 * single or multiple selection enabled, the views in the current selection
14322 * set are activated. (Um, yeah, we are deeply sorry about the terminology
14323 * here.) The activated state is propagated down to children of the view it
14324 * is set on.
14325 *
14326 * @param activated true if the view must be activated, false otherwise
14327 */
14328 public void setActivated(boolean activated) {
14329 if (((mPrivateFlags & ACTIVATED) != 0) != activated) {
14330 mPrivateFlags = (mPrivateFlags & ~ACTIVATED) | (activated ? ACTIVATED : 0);
Romain Guy0fd89bf2011-01-26 15:41:30 -080014331 invalidate(true);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014332 refreshDrawableState();
Dianne Hackbornc6669ca2010-09-16 01:33:24 -070014333 dispatchSetActivated(activated);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014334 }
14335 }
14336
14337 /**
14338 * Dispatch setActivated to all of this View's children.
14339 *
14340 * @see #setActivated(boolean)
14341 *
14342 * @param activated The new activated state
14343 */
14344 protected void dispatchSetActivated(boolean activated) {
14345 }
14346
14347 /**
14348 * Indicates the activation state of this view.
14349 *
14350 * @return true if the view is activated, false otherwise
14351 */
14352 @ViewDebug.ExportedProperty
14353 public boolean isActivated() {
14354 return (mPrivateFlags & ACTIVATED) != 0;
14355 }
14356
14357 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014358 * Returns the ViewTreeObserver for this view's hierarchy. The view tree
14359 * observer can be used to get notifications when global events, like
14360 * layout, happen.
14361 *
14362 * The returned ViewTreeObserver observer is not guaranteed to remain
14363 * valid for the lifetime of this View. If the caller of this method keeps
14364 * a long-lived reference to ViewTreeObserver, it should always check for
14365 * the return value of {@link ViewTreeObserver#isAlive()}.
14366 *
14367 * @return The ViewTreeObserver for this view's hierarchy.
14368 */
14369 public ViewTreeObserver getViewTreeObserver() {
14370 if (mAttachInfo != null) {
14371 return mAttachInfo.mTreeObserver;
14372 }
14373 if (mFloatingTreeObserver == null) {
14374 mFloatingTreeObserver = new ViewTreeObserver();
14375 }
14376 return mFloatingTreeObserver;
14377 }
14378
14379 /**
14380 * <p>Finds the topmost view in the current view hierarchy.</p>
14381 *
14382 * @return the topmost view containing this view
14383 */
14384 public View getRootView() {
14385 if (mAttachInfo != null) {
14386 final View v = mAttachInfo.mRootView;
14387 if (v != null) {
14388 return v;
14389 }
14390 }
Romain Guy8506ab42009-06-11 17:35:47 -070014391
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014392 View parent = this;
14393
14394 while (parent.mParent != null && parent.mParent instanceof View) {
14395 parent = (View) parent.mParent;
14396 }
14397
14398 return parent;
14399 }
14400
14401 /**
14402 * <p>Computes the coordinates of this view on the screen. The argument
14403 * must be an array of two integers. After the method returns, the array
14404 * contains the x and y location in that order.</p>
14405 *
14406 * @param location an array of two integers in which to hold the coordinates
14407 */
14408 public void getLocationOnScreen(int[] location) {
14409 getLocationInWindow(location);
14410
14411 final AttachInfo info = mAttachInfo;
Romain Guy779398e2009-06-16 13:17:50 -070014412 if (info != null) {
14413 location[0] += info.mWindowLeft;
14414 location[1] += info.mWindowTop;
14415 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014416 }
14417
14418 /**
14419 * <p>Computes the coordinates of this view in its window. The argument
14420 * must be an array of two integers. After the method returns, the array
14421 * contains the x and y location in that order.</p>
14422 *
14423 * @param location an array of two integers in which to hold the coordinates
14424 */
14425 public void getLocationInWindow(int[] location) {
14426 if (location == null || location.length < 2) {
Gilles Debunnecea45132011-11-24 02:19:27 +010014427 throw new IllegalArgumentException("location must be an array of two integers");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014428 }
14429
Gilles Debunne6583ce52011-12-06 18:09:02 -080014430 if (mAttachInfo == null) {
14431 // When the view is not attached to a window, this method does not make sense
14432 location[0] = location[1] = 0;
14433 return;
14434 }
14435
Gilles Debunnecea45132011-11-24 02:19:27 +010014436 float[] position = mAttachInfo.mTmpTransformLocation;
14437 position[0] = position[1] = 0.0f;
14438
14439 if (!hasIdentityMatrix()) {
14440 getMatrix().mapPoints(position);
Dianne Hackbornddb715b2011-09-09 14:43:39 -070014441 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014442
Gilles Debunnecea45132011-11-24 02:19:27 +010014443 position[0] += mLeft;
14444 position[1] += mTop;
14445
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014446 ViewParent viewParent = mParent;
14447 while (viewParent instanceof View) {
Gilles Debunnecea45132011-11-24 02:19:27 +010014448 final View view = (View) viewParent;
14449
14450 position[0] -= view.mScrollX;
14451 position[1] -= view.mScrollY;
14452
14453 if (!view.hasIdentityMatrix()) {
14454 view.getMatrix().mapPoints(position);
Dianne Hackbornddb715b2011-09-09 14:43:39 -070014455 }
Gilles Debunnecea45132011-11-24 02:19:27 +010014456
14457 position[0] += view.mLeft;
14458 position[1] += view.mTop;
14459
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014460 viewParent = view.mParent;
Svetoslav Ganov42138042012-03-20 11:51:39 -070014461 }
Romain Guy8506ab42009-06-11 17:35:47 -070014462
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070014463 if (viewParent instanceof ViewRootImpl) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014464 // *cough*
Gilles Debunnecea45132011-11-24 02:19:27 +010014465 final ViewRootImpl vr = (ViewRootImpl) viewParent;
14466 position[1] -= vr.mCurScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014467 }
Gilles Debunnecea45132011-11-24 02:19:27 +010014468
14469 location[0] = (int) (position[0] + 0.5f);
14470 location[1] = (int) (position[1] + 0.5f);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014471 }
14472
14473 /**
14474 * {@hide}
14475 * @param id the id of the view to be found
14476 * @return the view of the specified id, null if cannot be found
14477 */
14478 protected View findViewTraversal(int id) {
14479 if (id == mID) {
14480 return this;
14481 }
14482 return null;
14483 }
14484
14485 /**
14486 * {@hide}
14487 * @param tag the tag of the view to be found
14488 * @return the view of specified tag, null if cannot be found
14489 */
14490 protected View findViewWithTagTraversal(Object tag) {
14491 if (tag != null && tag.equals(mTag)) {
14492 return this;
14493 }
14494 return null;
14495 }
14496
14497 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -080014498 * {@hide}
14499 * @param predicate The predicate to evaluate.
Jeff Brown4dfbec22011-08-15 14:55:37 -070014500 * @param childToSkip If not null, ignores this child during the recursive traversal.
Jeff Brown4e6319b2010-12-13 10:36:51 -080014501 * @return The first view that matches the predicate or null.
14502 */
Jeff Brown4dfbec22011-08-15 14:55:37 -070014503 protected View findViewByPredicateTraversal(Predicate<View> predicate, View childToSkip) {
Jeff Brown4e6319b2010-12-13 10:36:51 -080014504 if (predicate.apply(this)) {
14505 return this;
14506 }
14507 return null;
14508 }
14509
14510 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014511 * Look for a child view with the given id. If this view has the given
14512 * id, return this view.
14513 *
14514 * @param id The id to search for.
14515 * @return The view that has the given id in the hierarchy or null
14516 */
14517 public final View findViewById(int id) {
14518 if (id < 0) {
14519 return null;
14520 }
14521 return findViewTraversal(id);
14522 }
14523
14524 /**
Svetoslav Ganov2cdedff2011-10-03 14:18:42 -070014525 * Finds a view by its unuque and stable accessibility id.
14526 *
14527 * @param accessibilityId The searched accessibility id.
14528 * @return The found view.
14529 */
14530 final View findViewByAccessibilityId(int accessibilityId) {
14531 if (accessibilityId < 0) {
14532 return null;
14533 }
14534 return findViewByAccessibilityIdTraversal(accessibilityId);
14535 }
14536
14537 /**
14538 * Performs the traversal to find a view by its unuque and stable accessibility id.
14539 *
14540 * <strong>Note:</strong>This method does not stop at the root namespace
14541 * boundary since the user can touch the screen at an arbitrary location
14542 * potentially crossing the root namespace bounday which will send an
14543 * accessibility event to accessibility services and they should be able
14544 * to obtain the event source. Also accessibility ids are guaranteed to be
14545 * unique in the window.
14546 *
14547 * @param accessibilityId The accessibility id.
14548 * @return The found view.
14549 */
14550 View findViewByAccessibilityIdTraversal(int accessibilityId) {
14551 if (getAccessibilityViewId() == accessibilityId) {
14552 return this;
14553 }
14554 return null;
14555 }
14556
14557 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014558 * Look for a child view with the given tag. If this view has the given
14559 * tag, return this view.
14560 *
14561 * @param tag The tag to search for, using "tag.equals(getTag())".
14562 * @return The View that has the given tag in the hierarchy or null
14563 */
14564 public final View findViewWithTag(Object tag) {
14565 if (tag == null) {
14566 return null;
14567 }
14568 return findViewWithTagTraversal(tag);
14569 }
14570
14571 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -080014572 * {@hide}
14573 * Look for a child view that matches the specified predicate.
14574 * If this view matches the predicate, return this view.
14575 *
14576 * @param predicate The predicate to evaluate.
14577 * @return The first view that matches the predicate or null.
14578 */
14579 public final View findViewByPredicate(Predicate<View> predicate) {
Jeff Brown4dfbec22011-08-15 14:55:37 -070014580 return findViewByPredicateTraversal(predicate, null);
14581 }
14582
14583 /**
14584 * {@hide}
14585 * Look for a child view that matches the specified predicate,
14586 * starting with the specified view and its descendents and then
14587 * recusively searching the ancestors and siblings of that view
14588 * until this view is reached.
14589 *
14590 * This method is useful in cases where the predicate does not match
14591 * a single unique view (perhaps multiple views use the same id)
14592 * and we are trying to find the view that is "closest" in scope to the
14593 * starting view.
14594 *
14595 * @param start The view to start from.
14596 * @param predicate The predicate to evaluate.
14597 * @return The first view that matches the predicate or null.
14598 */
14599 public final View findViewByPredicateInsideOut(View start, Predicate<View> predicate) {
14600 View childToSkip = null;
14601 for (;;) {
14602 View view = start.findViewByPredicateTraversal(predicate, childToSkip);
14603 if (view != null || start == this) {
14604 return view;
14605 }
14606
14607 ViewParent parent = start.getParent();
14608 if (parent == null || !(parent instanceof View)) {
14609 return null;
14610 }
14611
14612 childToSkip = start;
14613 start = (View) parent;
14614 }
Jeff Brown4e6319b2010-12-13 10:36:51 -080014615 }
14616
14617 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014618 * Sets the identifier for this view. The identifier does not have to be
14619 * unique in this view's hierarchy. The identifier should be a positive
14620 * number.
14621 *
14622 * @see #NO_ID
Philip Milne6c8ea062012-04-03 17:38:43 -070014623 * @see #getId()
14624 * @see #findViewById(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014625 *
14626 * @param id a number used to identify the view
14627 *
14628 * @attr ref android.R.styleable#View_id
14629 */
14630 public void setId(int id) {
14631 mID = id;
14632 }
14633
14634 /**
14635 * {@hide}
14636 *
14637 * @param isRoot true if the view belongs to the root namespace, false
14638 * otherwise
14639 */
14640 public void setIsRootNamespace(boolean isRoot) {
14641 if (isRoot) {
14642 mPrivateFlags |= IS_ROOT_NAMESPACE;
14643 } else {
14644 mPrivateFlags &= ~IS_ROOT_NAMESPACE;
14645 }
14646 }
14647
14648 /**
14649 * {@hide}
14650 *
14651 * @return true if the view belongs to the root namespace, false otherwise
14652 */
14653 public boolean isRootNamespace() {
14654 return (mPrivateFlags&IS_ROOT_NAMESPACE) != 0;
14655 }
14656
14657 /**
14658 * Returns this view's identifier.
14659 *
14660 * @return a positive integer used to identify the view or {@link #NO_ID}
14661 * if the view has no ID
14662 *
Philip Milne6c8ea062012-04-03 17:38:43 -070014663 * @see #setId(int)
14664 * @see #findViewById(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014665 * @attr ref android.R.styleable#View_id
14666 */
14667 @ViewDebug.CapturedViewProperty
14668 public int getId() {
14669 return mID;
14670 }
14671
14672 /**
14673 * Returns this view's tag.
14674 *
14675 * @return the Object stored in this view as a tag
Romain Guyd90a3312009-05-06 14:54:28 -070014676 *
14677 * @see #setTag(Object)
14678 * @see #getTag(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014679 */
14680 @ViewDebug.ExportedProperty
14681 public Object getTag() {
14682 return mTag;
14683 }
14684
14685 /**
14686 * Sets the tag associated with this view. A tag can be used to mark
14687 * a view in its hierarchy and does not have to be unique within the
14688 * hierarchy. Tags can also be used to store data within a view without
14689 * resorting to another data structure.
14690 *
14691 * @param tag an Object to tag the view with
Romain Guyd90a3312009-05-06 14:54:28 -070014692 *
14693 * @see #getTag()
14694 * @see #setTag(int, Object)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014695 */
14696 public void setTag(final Object tag) {
14697 mTag = tag;
14698 }
14699
14700 /**
Romain Guyd90a3312009-05-06 14:54:28 -070014701 * Returns the tag associated with this view and the specified key.
14702 *
14703 * @param key The key identifying the tag
14704 *
14705 * @return the Object stored in this view as a tag
14706 *
14707 * @see #setTag(int, Object)
Romain Guy8506ab42009-06-11 17:35:47 -070014708 * @see #getTag()
Romain Guyd90a3312009-05-06 14:54:28 -070014709 */
14710 public Object getTag(int key) {
Adam Powell7db82ac2011-09-22 19:44:04 -070014711 if (mKeyedTags != null) return mKeyedTags.get(key);
Romain Guyd90a3312009-05-06 14:54:28 -070014712 return null;
14713 }
14714
14715 /**
14716 * Sets a tag associated with this view and a key. A tag can be used
14717 * to mark a view in its hierarchy and does not have to be unique within
14718 * the hierarchy. Tags can also be used to store data within a view
14719 * without resorting to another data structure.
14720 *
14721 * The specified key should be an id declared in the resources of the
Scott Maindfe5c202010-06-08 15:54:52 -070014722 * application to ensure it is unique (see the <a
14723 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>).
14724 * Keys identified as belonging to
Romain Guyd90a3312009-05-06 14:54:28 -070014725 * the Android framework or not associated with any package will cause
14726 * an {@link IllegalArgumentException} to be thrown.
14727 *
14728 * @param key The key identifying the tag
14729 * @param tag An Object to tag the view with
14730 *
14731 * @throws IllegalArgumentException If they specified key is not valid
14732 *
14733 * @see #setTag(Object)
14734 * @see #getTag(int)
14735 */
14736 public void setTag(int key, final Object tag) {
14737 // If the package id is 0x00 or 0x01, it's either an undefined package
14738 // or a framework id
14739 if ((key >>> 24) < 2) {
14740 throw new IllegalArgumentException("The key must be an application-specific "
14741 + "resource id.");
14742 }
14743
Adam Powell2b2f6d62011-09-23 11:15:39 -070014744 setKeyedTag(key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070014745 }
14746
14747 /**
14748 * Variation of {@link #setTag(int, Object)} that enforces the key to be a
14749 * framework id.
14750 *
14751 * @hide
14752 */
14753 public void setTagInternal(int key, Object tag) {
14754 if ((key >>> 24) != 0x1) {
14755 throw new IllegalArgumentException("The key must be a framework-specific "
14756 + "resource id.");
14757 }
14758
Adam Powell2b2f6d62011-09-23 11:15:39 -070014759 setKeyedTag(key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070014760 }
14761
Adam Powell2b2f6d62011-09-23 11:15:39 -070014762 private void setKeyedTag(int key, Object tag) {
Adam Powell7db82ac2011-09-22 19:44:04 -070014763 if (mKeyedTags == null) {
14764 mKeyedTags = new SparseArray<Object>();
Romain Guyd90a3312009-05-06 14:54:28 -070014765 }
14766
Adam Powell7db82ac2011-09-22 19:44:04 -070014767 mKeyedTags.put(key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070014768 }
14769
14770 /**
Romain Guy13922e02009-05-12 17:56:14 -070014771 * @param consistency The type of consistency. See ViewDebug for more information.
14772 *
14773 * @hide
14774 */
14775 protected boolean dispatchConsistencyCheck(int consistency) {
14776 return onConsistencyCheck(consistency);
14777 }
14778
14779 /**
14780 * Method that subclasses should implement to check their consistency. The type of
14781 * consistency check is indicated by the bit field passed as a parameter.
Romain Guy8506ab42009-06-11 17:35:47 -070014782 *
Romain Guy13922e02009-05-12 17:56:14 -070014783 * @param consistency The type of consistency. See ViewDebug for more information.
14784 *
14785 * @throws IllegalStateException if the view is in an inconsistent state.
14786 *
14787 * @hide
14788 */
14789 protected boolean onConsistencyCheck(int consistency) {
14790 boolean result = true;
14791
14792 final boolean checkLayout = (consistency & ViewDebug.CONSISTENCY_LAYOUT) != 0;
14793 final boolean checkDrawing = (consistency & ViewDebug.CONSISTENCY_DRAWING) != 0;
14794
14795 if (checkLayout) {
14796 if (getParent() == null) {
14797 result = false;
14798 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
14799 "View " + this + " does not have a parent.");
14800 }
14801
14802 if (mAttachInfo == null) {
14803 result = false;
14804 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
14805 "View " + this + " is not attached to a window.");
14806 }
14807 }
14808
14809 if (checkDrawing) {
14810 // Do not check the DIRTY/DRAWN flags because views can call invalidate()
14811 // from their draw() method
14812
14813 if ((mPrivateFlags & DRAWN) != DRAWN &&
14814 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
14815 result = false;
14816 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
14817 "View " + this + " was invalidated but its drawing cache is valid.");
14818 }
14819 }
14820
14821 return result;
14822 }
14823
14824 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014825 * Prints information about this view in the log output, with the tag
14826 * {@link #VIEW_LOG_TAG}.
14827 *
14828 * @hide
14829 */
14830 public void debug() {
14831 debug(0);
14832 }
14833
14834 /**
14835 * Prints information about this view in the log output, with the tag
14836 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an
14837 * indentation defined by the <code>depth</code>.
14838 *
14839 * @param depth the indentation level
14840 *
14841 * @hide
14842 */
14843 protected void debug(int depth) {
14844 String output = debugIndent(depth - 1);
14845
14846 output += "+ " + this;
14847 int id = getId();
14848 if (id != -1) {
14849 output += " (id=" + id + ")";
14850 }
14851 Object tag = getTag();
14852 if (tag != null) {
14853 output += " (tag=" + tag + ")";
14854 }
14855 Log.d(VIEW_LOG_TAG, output);
14856
14857 if ((mPrivateFlags & FOCUSED) != 0) {
14858 output = debugIndent(depth) + " FOCUSED";
14859 Log.d(VIEW_LOG_TAG, output);
14860 }
14861
14862 output = debugIndent(depth);
14863 output += "frame={" + mLeft + ", " + mTop + ", " + mRight
14864 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY
14865 + "} ";
14866 Log.d(VIEW_LOG_TAG, output);
14867
14868 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0
14869 || mPaddingBottom != 0) {
14870 output = debugIndent(depth);
14871 output += "padding={" + mPaddingLeft + ", " + mPaddingTop
14872 + ", " + mPaddingRight + ", " + mPaddingBottom + "}";
14873 Log.d(VIEW_LOG_TAG, output);
14874 }
14875
14876 output = debugIndent(depth);
14877 output += "mMeasureWidth=" + mMeasuredWidth +
14878 " mMeasureHeight=" + mMeasuredHeight;
14879 Log.d(VIEW_LOG_TAG, output);
14880
14881 output = debugIndent(depth);
14882 if (mLayoutParams == null) {
14883 output += "BAD! no layout params";
14884 } else {
14885 output = mLayoutParams.debug(output);
14886 }
14887 Log.d(VIEW_LOG_TAG, output);
14888
14889 output = debugIndent(depth);
14890 output += "flags={";
14891 output += View.printFlags(mViewFlags);
14892 output += "}";
14893 Log.d(VIEW_LOG_TAG, output);
14894
14895 output = debugIndent(depth);
14896 output += "privateFlags={";
14897 output += View.printPrivateFlags(mPrivateFlags);
14898 output += "}";
14899 Log.d(VIEW_LOG_TAG, output);
14900 }
14901
14902 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +090014903 * Creates a string of whitespaces used for indentation.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014904 *
14905 * @param depth the indentation level
14906 * @return a String containing (depth * 2 + 3) * 2 white spaces
14907 *
14908 * @hide
14909 */
14910 protected static String debugIndent(int depth) {
14911 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2);
14912 for (int i = 0; i < (depth * 2) + 3; i++) {
14913 spaces.append(' ').append(' ');
14914 }
14915 return spaces.toString();
14916 }
14917
14918 /**
14919 * <p>Return the offset of the widget's text baseline from the widget's top
14920 * boundary. If this widget does not support baseline alignment, this
14921 * method returns -1. </p>
14922 *
14923 * @return the offset of the baseline within the widget's bounds or -1
14924 * if baseline alignment is not supported
14925 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070014926 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014927 public int getBaseline() {
14928 return -1;
14929 }
14930
14931 /**
14932 * Call this when something has changed which has invalidated the
14933 * layout of this view. This will schedule a layout pass of the view
14934 * tree.
14935 */
14936 public void requestLayout() {
14937 if (ViewDebug.TRACE_HIERARCHY) {
14938 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.REQUEST_LAYOUT);
14939 }
14940
14941 mPrivateFlags |= FORCE_LAYOUT;
Chet Haase5af048c2011-01-24 17:00:32 -080014942 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014943
Fabrice Di Meglio4a5268852012-03-30 15:56:48 -070014944 if (mLayoutParams != null) {
14945 mLayoutParams.onResolveLayoutDirection(getResolvedLayoutDirection());
14946 }
14947
14948 if (mParent != null && !mParent.isLayoutRequested()) {
14949 mParent.requestLayout();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014950 }
14951 }
14952
14953 /**
14954 * Forces this view to be laid out during the next layout pass.
14955 * This method does not call requestLayout() or forceLayout()
14956 * on the parent.
14957 */
14958 public void forceLayout() {
14959 mPrivateFlags |= FORCE_LAYOUT;
Chet Haase5af048c2011-01-24 17:00:32 -080014960 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014961 }
14962
14963 /**
14964 * <p>
14965 * This is called to find out how big a view should be. The parent
14966 * supplies constraint information in the width and height parameters.
14967 * </p>
14968 *
14969 * <p>
Romain Guy967e2bf2012-02-07 17:04:34 -080014970 * The actual measurement work of a view is performed in
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014971 * {@link #onMeasure(int, int)}, called by this method. Therefore, only
Romain Guy967e2bf2012-02-07 17:04:34 -080014972 * {@link #onMeasure(int, int)} can and must be overridden by subclasses.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014973 * </p>
14974 *
14975 *
14976 * @param widthMeasureSpec Horizontal space requirements as imposed by the
14977 * parent
14978 * @param heightMeasureSpec Vertical space requirements as imposed by the
14979 * parent
14980 *
14981 * @see #onMeasure(int, int)
14982 */
14983 public final void measure(int widthMeasureSpec, int heightMeasureSpec) {
14984 if ((mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT ||
14985 widthMeasureSpec != mOldWidthMeasureSpec ||
14986 heightMeasureSpec != mOldHeightMeasureSpec) {
14987
14988 // first clears the measured dimension flag
14989 mPrivateFlags &= ~MEASURED_DIMENSION_SET;
14990
14991 if (ViewDebug.TRACE_HIERARCHY) {
14992 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_MEASURE);
14993 }
14994
14995 // measure ourselves, this should set the measured dimension flag back
14996 onMeasure(widthMeasureSpec, heightMeasureSpec);
14997
14998 // flag not set, setMeasuredDimension() was not invoked, we raise
14999 // an exception to warn the developer
15000 if ((mPrivateFlags & MEASURED_DIMENSION_SET) != MEASURED_DIMENSION_SET) {
15001 throw new IllegalStateException("onMeasure() did not set the"
15002 + " measured dimension by calling"
15003 + " setMeasuredDimension()");
15004 }
15005
15006 mPrivateFlags |= LAYOUT_REQUIRED;
15007 }
15008
15009 mOldWidthMeasureSpec = widthMeasureSpec;
15010 mOldHeightMeasureSpec = heightMeasureSpec;
15011 }
15012
15013 /**
15014 * <p>
15015 * Measure the view and its content to determine the measured width and the
15016 * measured height. This method is invoked by {@link #measure(int, int)} and
15017 * should be overriden by subclasses to provide accurate and efficient
15018 * measurement of their contents.
15019 * </p>
15020 *
15021 * <p>
15022 * <strong>CONTRACT:</strong> When overriding this method, you
15023 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the
15024 * measured width and height of this view. Failure to do so will trigger an
15025 * <code>IllegalStateException</code>, thrown by
15026 * {@link #measure(int, int)}. Calling the superclass'
15027 * {@link #onMeasure(int, int)} is a valid use.
15028 * </p>
15029 *
15030 * <p>
15031 * The base class implementation of measure defaults to the background size,
15032 * unless a larger size is allowed by the MeasureSpec. Subclasses should
15033 * override {@link #onMeasure(int, int)} to provide better measurements of
15034 * their content.
15035 * </p>
15036 *
15037 * <p>
15038 * If this method is overridden, it is the subclass's responsibility to make
15039 * sure the measured height and width are at least the view's minimum height
15040 * and width ({@link #getSuggestedMinimumHeight()} and
15041 * {@link #getSuggestedMinimumWidth()}).
15042 * </p>
15043 *
15044 * @param widthMeasureSpec horizontal space requirements as imposed by the parent.
15045 * The requirements are encoded with
15046 * {@link android.view.View.MeasureSpec}.
15047 * @param heightMeasureSpec vertical space requirements as imposed by the parent.
15048 * The requirements are encoded with
15049 * {@link android.view.View.MeasureSpec}.
15050 *
15051 * @see #getMeasuredWidth()
15052 * @see #getMeasuredHeight()
15053 * @see #setMeasuredDimension(int, int)
15054 * @see #getSuggestedMinimumHeight()
15055 * @see #getSuggestedMinimumWidth()
15056 * @see android.view.View.MeasureSpec#getMode(int)
15057 * @see android.view.View.MeasureSpec#getSize(int)
15058 */
15059 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
15060 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec),
15061 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec));
15062 }
15063
15064 /**
15065 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the
15066 * measured width and measured height. Failing to do so will trigger an
15067 * exception at measurement time.</p>
15068 *
Dianne Hackborn189ee182010-12-02 21:48:53 -080015069 * @param measuredWidth The measured width of this view. May be a complex
15070 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
15071 * {@link #MEASURED_STATE_TOO_SMALL}.
15072 * @param measuredHeight The measured height of this view. May be a complex
15073 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
15074 * {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015075 */
15076 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) {
15077 mMeasuredWidth = measuredWidth;
15078 mMeasuredHeight = measuredHeight;
15079
15080 mPrivateFlags |= MEASURED_DIMENSION_SET;
15081 }
15082
15083 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -080015084 * Merge two states as returned by {@link #getMeasuredState()}.
15085 * @param curState The current state as returned from a view or the result
15086 * of combining multiple views.
15087 * @param newState The new view state to combine.
15088 * @return Returns a new integer reflecting the combination of the two
15089 * states.
15090 */
15091 public static int combineMeasuredStates(int curState, int newState) {
15092 return curState | newState;
15093 }
15094
15095 /**
15096 * Version of {@link #resolveSizeAndState(int, int, int)}
15097 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result.
15098 */
15099 public static int resolveSize(int size, int measureSpec) {
15100 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK;
15101 }
15102
15103 /**
15104 * Utility to reconcile a desired size and state, with constraints imposed
15105 * by a MeasureSpec. Will take the desired size, unless a different size
15106 * is imposed by the constraints. The returned value is a compound integer,
15107 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and
15108 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting
15109 * size is smaller than the size the view wants to be.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015110 *
15111 * @param size How big the view wants to be
15112 * @param measureSpec Constraints imposed by the parent
Dianne Hackborn189ee182010-12-02 21:48:53 -080015113 * @return Size information bit mask as defined by
15114 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015115 */
Dianne Hackborn189ee182010-12-02 21:48:53 -080015116 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015117 int result = size;
15118 int specMode = MeasureSpec.getMode(measureSpec);
15119 int specSize = MeasureSpec.getSize(measureSpec);
15120 switch (specMode) {
15121 case MeasureSpec.UNSPECIFIED:
15122 result = size;
15123 break;
15124 case MeasureSpec.AT_MOST:
Dianne Hackborn189ee182010-12-02 21:48:53 -080015125 if (specSize < size) {
15126 result = specSize | MEASURED_STATE_TOO_SMALL;
15127 } else {
15128 result = size;
15129 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015130 break;
15131 case MeasureSpec.EXACTLY:
15132 result = specSize;
15133 break;
15134 }
Dianne Hackborn189ee182010-12-02 21:48:53 -080015135 return result | (childMeasuredState&MEASURED_STATE_MASK);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015136 }
15137
15138 /**
15139 * Utility to return a default size. Uses the supplied size if the
Romain Guy98029c82011-06-17 15:47:07 -070015140 * MeasureSpec imposed no constraints. Will get larger if allowed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015141 * by the MeasureSpec.
15142 *
15143 * @param size Default size for this view
15144 * @param measureSpec Constraints imposed by the parent
15145 * @return The size this view should be.
15146 */
15147 public static int getDefaultSize(int size, int measureSpec) {
15148 int result = size;
15149 int specMode = MeasureSpec.getMode(measureSpec);
Romain Guy98029c82011-06-17 15:47:07 -070015150 int specSize = MeasureSpec.getSize(measureSpec);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015151
15152 switch (specMode) {
15153 case MeasureSpec.UNSPECIFIED:
15154 result = size;
15155 break;
15156 case MeasureSpec.AT_MOST:
15157 case MeasureSpec.EXACTLY:
15158 result = specSize;
15159 break;
15160 }
15161 return result;
15162 }
15163
15164 /**
15165 * Returns the suggested minimum height that the view should use. This
15166 * returns the maximum of the view's minimum height
15167 * and the background's minimum height
15168 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}).
15169 * <p>
15170 * When being used in {@link #onMeasure(int, int)}, the caller should still
15171 * ensure the returned height is within the requirements of the parent.
15172 *
15173 * @return The suggested minimum height of the view.
15174 */
15175 protected int getSuggestedMinimumHeight() {
Philip Milne6c8ea062012-04-03 17:38:43 -070015176 return (mBackground == null) ? mMinHeight : max(mMinHeight, mBackground.getMinimumHeight());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015177
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015178 }
15179
15180 /**
15181 * Returns the suggested minimum width that the view should use. This
15182 * returns the maximum of the view's minimum width)
15183 * and the background's minimum width
15184 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}).
15185 * <p>
15186 * When being used in {@link #onMeasure(int, int)}, the caller should still
15187 * ensure the returned width is within the requirements of the parent.
15188 *
15189 * @return The suggested minimum width of the view.
15190 */
15191 protected int getSuggestedMinimumWidth() {
Philip Milne6c8ea062012-04-03 17:38:43 -070015192 return (mBackground == null) ? mMinWidth : max(mMinWidth, mBackground.getMinimumWidth());
15193 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015194
Philip Milne6c8ea062012-04-03 17:38:43 -070015195 /**
15196 * Returns the minimum height of the view.
15197 *
15198 * @return the minimum height the view will try to be.
15199 *
15200 * @see #setMinimumHeight(int)
15201 *
15202 * @attr ref android.R.styleable#View_minHeight
15203 */
15204 public int getMinimumHeight() {
15205 return mMinHeight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015206 }
15207
15208 /**
15209 * Sets the minimum height of the view. It is not guaranteed the view will
15210 * be able to achieve this minimum height (for example, if its parent layout
15211 * constrains it with less available height).
15212 *
15213 * @param minHeight The minimum height the view will try to be.
Philip Milne6c8ea062012-04-03 17:38:43 -070015214 *
15215 * @see #getMinimumHeight()
15216 *
15217 * @attr ref android.R.styleable#View_minHeight
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015218 */
15219 public void setMinimumHeight(int minHeight) {
15220 mMinHeight = minHeight;
Philip Milne6c8ea062012-04-03 17:38:43 -070015221 requestLayout();
15222 }
15223
15224 /**
15225 * Returns the minimum width of the view.
15226 *
15227 * @return the minimum width the view will try to be.
15228 *
15229 * @see #setMinimumWidth(int)
15230 *
15231 * @attr ref android.R.styleable#View_minWidth
15232 */
15233 public int getMinimumWidth() {
15234 return mMinWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015235 }
15236
15237 /**
15238 * Sets the minimum width of the view. It is not guaranteed the view will
15239 * be able to achieve this minimum width (for example, if its parent layout
15240 * constrains it with less available width).
15241 *
15242 * @param minWidth The minimum width the view will try to be.
Philip Milne6c8ea062012-04-03 17:38:43 -070015243 *
15244 * @see #getMinimumWidth()
15245 *
15246 * @attr ref android.R.styleable#View_minWidth
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015247 */
15248 public void setMinimumWidth(int minWidth) {
15249 mMinWidth = minWidth;
Philip Milne6c8ea062012-04-03 17:38:43 -070015250 requestLayout();
15251
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015252 }
15253
15254 /**
15255 * Get the animation currently associated with this view.
15256 *
15257 * @return The animation that is currently playing or
15258 * scheduled to play for this view.
15259 */
15260 public Animation getAnimation() {
15261 return mCurrentAnimation;
15262 }
15263
15264 /**
15265 * Start the specified animation now.
15266 *
15267 * @param animation the animation to start now
15268 */
15269 public void startAnimation(Animation animation) {
15270 animation.setStartTime(Animation.START_ON_FIRST_FRAME);
15271 setAnimation(animation);
Romain Guy0fd89bf2011-01-26 15:41:30 -080015272 invalidateParentCaches();
15273 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015274 }
15275
15276 /**
15277 * Cancels any animations for this view.
15278 */
15279 public void clearAnimation() {
Romain Guy305a2eb2010-02-09 11:30:44 -080015280 if (mCurrentAnimation != null) {
Romain Guyb4a107d2010-02-09 18:50:08 -080015281 mCurrentAnimation.detach();
Romain Guy305a2eb2010-02-09 11:30:44 -080015282 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015283 mCurrentAnimation = null;
Romain Guy0fd89bf2011-01-26 15:41:30 -080015284 invalidateParentIfNeeded();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015285 }
15286
15287 /**
15288 * Sets the next animation to play for this view.
15289 * If you want the animation to play immediately, use
Chet Haase42428932012-05-11 15:39:07 -070015290 * {@link #startAnimation(android.view.animation.Animation)} instead.
15291 * This method provides allows fine-grained
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015292 * control over the start time and invalidation, but you
15293 * must make sure that 1) the animation has a start time set, and
Chet Haase42428932012-05-11 15:39:07 -070015294 * 2) the view's parent (which controls animations on its children)
15295 * will be invalidated when the animation is supposed to
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015296 * start.
15297 *
15298 * @param animation The next animation, or null.
15299 */
15300 public void setAnimation(Animation animation) {
15301 mCurrentAnimation = animation;
Romain Guyeb378892012-04-12 11:33:14 -070015302
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015303 if (animation != null) {
Romain Guyeb378892012-04-12 11:33:14 -070015304 // If the screen is off assume the animation start time is now instead of
15305 // the next frame we draw. Keeping the START_ON_FIRST_FRAME start time
15306 // would cause the animation to start when the screen turns back on
15307 if (mAttachInfo != null && !mAttachInfo.mScreenOn &&
15308 animation.getStartTime() == Animation.START_ON_FIRST_FRAME) {
15309 animation.setStartTime(AnimationUtils.currentAnimationTimeMillis());
15310 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015311 animation.reset();
15312 }
15313 }
15314
15315 /**
15316 * Invoked by a parent ViewGroup to notify the start of the animation
15317 * currently associated with this view. If you override this method,
15318 * always call super.onAnimationStart();
15319 *
15320 * @see #setAnimation(android.view.animation.Animation)
15321 * @see #getAnimation()
15322 */
15323 protected void onAnimationStart() {
15324 mPrivateFlags |= ANIMATION_STARTED;
15325 }
15326
15327 /**
15328 * Invoked by a parent ViewGroup to notify the end of the animation
15329 * currently associated with this view. If you override this method,
15330 * always call super.onAnimationEnd();
15331 *
15332 * @see #setAnimation(android.view.animation.Animation)
15333 * @see #getAnimation()
15334 */
15335 protected void onAnimationEnd() {
15336 mPrivateFlags &= ~ANIMATION_STARTED;
15337 }
15338
15339 /**
15340 * Invoked if there is a Transform that involves alpha. Subclass that can
15341 * draw themselves with the specified alpha should return true, and then
15342 * respect that alpha when their onDraw() is called. If this returns false
15343 * then the view may be redirected to draw into an offscreen buffer to
15344 * fulfill the request, which will look fine, but may be slower than if the
15345 * subclass handles it internally. The default implementation returns false.
15346 *
15347 * @param alpha The alpha (0..255) to apply to the view's drawing
15348 * @return true if the view can draw with the specified alpha.
15349 */
15350 protected boolean onSetAlpha(int alpha) {
15351 return false;
15352 }
15353
15354 /**
15355 * This is used by the RootView to perform an optimization when
15356 * the view hierarchy contains one or several SurfaceView.
15357 * SurfaceView is always considered transparent, but its children are not,
15358 * therefore all View objects remove themselves from the global transparent
15359 * region (passed as a parameter to this function).
15360 *
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070015361 * @param region The transparent region for this ViewAncestor (window).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015362 *
15363 * @return Returns true if the effective visibility of the view at this
15364 * point is opaque, regardless of the transparent region; returns false
15365 * if it is possible for underlying windows to be seen behind the view.
15366 *
15367 * {@hide}
15368 */
15369 public boolean gatherTransparentRegion(Region region) {
15370 final AttachInfo attachInfo = mAttachInfo;
15371 if (region != null && attachInfo != null) {
15372 final int pflags = mPrivateFlags;
15373 if ((pflags & SKIP_DRAW) == 0) {
15374 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to
15375 // remove it from the transparent region.
15376 final int[] location = attachInfo.mTransparentLocation;
15377 getLocationInWindow(location);
15378 region.op(location[0], location[1], location[0] + mRight - mLeft,
15379 location[1] + mBottom - mTop, Region.Op.DIFFERENCE);
Philip Milne6c8ea062012-04-03 17:38:43 -070015380 } else if ((pflags & ONLY_DRAWS_BACKGROUND) != 0 && mBackground != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015381 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable
15382 // exists, so we remove the background drawable's non-transparent
15383 // parts from this transparent region.
Philip Milne6c8ea062012-04-03 17:38:43 -070015384 applyDrawableToTransparentRegion(mBackground, region);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015385 }
15386 }
15387 return true;
15388 }
15389
15390 /**
15391 * Play a sound effect for this view.
15392 *
15393 * <p>The framework will play sound effects for some built in actions, such as
15394 * clicking, but you may wish to play these effects in your widget,
15395 * for instance, for internal navigation.
15396 *
15397 * <p>The sound effect will only be played if sound effects are enabled by the user, and
15398 * {@link #isSoundEffectsEnabled()} is true.
15399 *
15400 * @param soundConstant One of the constants defined in {@link SoundEffectConstants}
15401 */
15402 public void playSoundEffect(int soundConstant) {
15403 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) {
15404 return;
15405 }
15406 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant);
15407 }
15408
15409 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015410 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070015411 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015412 * <p>Provide haptic feedback to the user for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015413 *
15414 * <p>The framework will provide haptic feedback for some built in actions,
15415 * such as long presses, but you may wish to provide feedback for your
15416 * own widget.
15417 *
15418 * <p>The feedback will only be performed if
15419 * {@link #isHapticFeedbackEnabled()} is true.
15420 *
15421 * @param feedbackConstant One of the constants defined in
15422 * {@link HapticFeedbackConstants}
15423 */
15424 public boolean performHapticFeedback(int feedbackConstant) {
15425 return performHapticFeedback(feedbackConstant, 0);
15426 }
15427
15428 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015429 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070015430 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015431 * <p>Like {@link #performHapticFeedback(int)}, with additional options.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015432 *
15433 * @param feedbackConstant One of the constants defined in
15434 * {@link HapticFeedbackConstants}
15435 * @param flags Additional flags as per {@link HapticFeedbackConstants}.
15436 */
15437 public boolean performHapticFeedback(int feedbackConstant, int flags) {
15438 if (mAttachInfo == null) {
15439 return false;
15440 }
Romain Guyf607bdc2010-09-10 19:20:06 -070015441 //noinspection SimplifiableIfStatement
Romain Guy812ccbe2010-06-01 14:07:24 -070015442 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015443 && !isHapticFeedbackEnabled()) {
15444 return false;
15445 }
Romain Guy812ccbe2010-06-01 14:07:24 -070015446 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant,
15447 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015448 }
15449
15450 /**
Dianne Hackborn98014352012-04-05 18:31:41 -070015451 * Request that the visibility of the status bar or other screen/window
15452 * decorations be changed.
15453 *
15454 * <p>This method is used to put the over device UI into temporary modes
15455 * where the user's attention is focused more on the application content,
15456 * by dimming or hiding surrounding system affordances. This is typically
15457 * used in conjunction with {@link Window#FEATURE_ACTION_BAR_OVERLAY
15458 * Window.FEATURE_ACTION_BAR_OVERLAY}, allowing the applications content
15459 * to be placed behind the action bar (and with these flags other system
15460 * affordances) so that smooth transitions between hiding and showing them
15461 * can be done.
15462 *
15463 * <p>Two representative examples of the use of system UI visibility is
15464 * implementing a content browsing application (like a magazine reader)
15465 * and a video playing application.
15466 *
15467 * <p>The first code shows a typical implementation of a View in a content
15468 * browsing application. In this implementation, the application goes
15469 * into a content-oriented mode by hiding the status bar and action bar,
15470 * and putting the navigation elements into lights out mode. The user can
15471 * then interact with content while in this mode. Such an application should
15472 * provide an easy way for the user to toggle out of the mode (such as to
15473 * check information in the status bar or access notifications). In the
15474 * implementation here, this is done simply by tapping on the content.
15475 *
15476 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/ContentBrowserActivity.java
15477 * content}
15478 *
15479 * <p>This second code sample shows a typical implementation of a View
15480 * in a video playing application. In this situation, while the video is
15481 * playing the application would like to go into a complete full-screen mode,
15482 * to use as much of the display as possible for the video. When in this state
15483 * the user can not interact with the application; the system intercepts
Dianne Hackborncf675782012-05-10 15:07:24 -070015484 * touching on the screen to pop the UI out of full screen mode. See
15485 * {@link #fitSystemWindows(Rect)} for a sample layout that goes with this code.
Dianne Hackborn98014352012-04-05 18:31:41 -070015486 *
15487 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/VideoPlayerActivity.java
15488 * content}
15489 *
15490 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE},
15491 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN},
15492 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION},
15493 * and {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}.
Joe Onorato664644d2011-01-23 17:53:23 -080015494 */
15495 public void setSystemUiVisibility(int visibility) {
Daniel Sandler70524062011-09-21 00:30:47 -040015496 if (visibility != mSystemUiVisibility) {
15497 mSystemUiVisibility = visibility;
15498 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
15499 mParent.recomputeViewAttributes(this);
15500 }
Joe Onorato664644d2011-01-23 17:53:23 -080015501 }
15502 }
15503
15504 /**
Dianne Hackborn98014352012-04-05 18:31:41 -070015505 * Returns the last {@link #setSystemUiVisibility(int) that this view has requested.
15506 * @return Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE},
15507 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN},
15508 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION},
15509 * and {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}.
Joe Onorato664644d2011-01-23 17:53:23 -080015510 */
Joe Onoratoe595cad2011-01-24 09:22:12 -080015511 public int getSystemUiVisibility() {
Joe Onorato664644d2011-01-23 17:53:23 -080015512 return mSystemUiVisibility;
15513 }
15514
Scott Mainec6331b2011-05-24 16:55:56 -070015515 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -070015516 * Returns the current system UI visibility that is currently set for
15517 * the entire window. This is the combination of the
15518 * {@link #setSystemUiVisibility(int)} values supplied by all of the
15519 * views in the window.
15520 */
15521 public int getWindowSystemUiVisibility() {
15522 return mAttachInfo != null ? mAttachInfo.mSystemUiVisibility : 0;
15523 }
15524
15525 /**
15526 * Override to find out when the window's requested system UI visibility
15527 * has changed, that is the value returned by {@link #getWindowSystemUiVisibility()}.
15528 * This is different from the callbacks recieved through
15529 * {@link #setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener)}
15530 * in that this is only telling you about the local request of the window,
15531 * not the actual values applied by the system.
15532 */
15533 public void onWindowSystemUiVisibilityChanged(int visible) {
15534 }
15535
15536 /**
15537 * Dispatch callbacks to {@link #onWindowSystemUiVisibilityChanged(int)} down
15538 * the view hierarchy.
15539 */
15540 public void dispatchWindowSystemUiVisiblityChanged(int visible) {
15541 onWindowSystemUiVisibilityChanged(visible);
15542 }
15543
15544 /**
Scott Mainec6331b2011-05-24 16:55:56 -070015545 * Set a listener to receive callbacks when the visibility of the system bar changes.
15546 * @param l The {@link OnSystemUiVisibilityChangeListener} to receive callbacks.
15547 */
Joe Onorato664644d2011-01-23 17:53:23 -080015548 public void setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070015549 getListenerInfo().mOnSystemUiVisibilityChangeListener = l;
Joe Onorato664644d2011-01-23 17:53:23 -080015550 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
15551 mParent.recomputeViewAttributes(this);
15552 }
15553 }
15554
15555 /**
Dianne Hackborn9a230e02011-10-06 11:51:27 -070015556 * Dispatch callbacks to {@link #setOnSystemUiVisibilityChangeListener} down
15557 * the view hierarchy.
Joe Onorato664644d2011-01-23 17:53:23 -080015558 */
15559 public void dispatchSystemUiVisibilityChanged(int visibility) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070015560 ListenerInfo li = mListenerInfo;
15561 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) {
15562 li.mOnSystemUiVisibilityChangeListener.onSystemUiVisibilityChange(
Joe Onorato6ab77bd2011-01-31 11:21:10 -080015563 visibility & PUBLIC_STATUS_BAR_VISIBILITY_MASK);
Joe Onorato664644d2011-01-23 17:53:23 -080015564 }
15565 }
15566
Dianne Hackborncf675782012-05-10 15:07:24 -070015567 boolean updateLocalSystemUiVisibility(int localValue, int localChanges) {
Dianne Hackborn9a230e02011-10-06 11:51:27 -070015568 int val = (mSystemUiVisibility&~localChanges) | (localValue&localChanges);
15569 if (val != mSystemUiVisibility) {
15570 setSystemUiVisibility(val);
Dianne Hackborncf675782012-05-10 15:07:24 -070015571 return true;
Dianne Hackborn9a230e02011-10-06 11:51:27 -070015572 }
Dianne Hackborncf675782012-05-10 15:07:24 -070015573 return false;
Dianne Hackborn9a230e02011-10-06 11:51:27 -070015574 }
15575
Dianne Hackborn139e5aa2012-05-05 20:36:38 -070015576 /** @hide */
15577 public void setDisabledSystemUiVisibility(int flags) {
15578 if (mAttachInfo != null) {
15579 if (mAttachInfo.mDisabledSystemUiVisibility != flags) {
15580 mAttachInfo.mDisabledSystemUiVisibility = flags;
15581 if (mParent != null) {
15582 mParent.recomputeViewAttributes(this);
15583 }
15584 }
15585 }
15586 }
15587
Joe Onorato664644d2011-01-23 17:53:23 -080015588 /**
Joe Malin32736f02011-01-19 16:14:20 -080015589 * Creates an image that the system displays during the drag and drop
15590 * operation. This is called a &quot;drag shadow&quot;. The default implementation
15591 * for a DragShadowBuilder based on a View returns an image that has exactly the same
15592 * appearance as the given View. The default also positions the center of the drag shadow
15593 * directly under the touch point. If no View is provided (the constructor with no parameters
15594 * is used), and {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} and
15595 * {@link #onDrawShadow(Canvas) onDrawShadow()} are not overriden, then the
15596 * default is an invisible drag shadow.
15597 * <p>
15598 * You are not required to use the View you provide to the constructor as the basis of the
15599 * drag shadow. The {@link #onDrawShadow(Canvas) onDrawShadow()} method allows you to draw
15600 * anything you want as the drag shadow.
15601 * </p>
15602 * <p>
15603 * You pass a DragShadowBuilder object to the system when you start the drag. The system
15604 * calls {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} to get the
15605 * size and position of the drag shadow. It uses this data to construct a
15606 * {@link android.graphics.Canvas} object, then it calls {@link #onDrawShadow(Canvas) onDrawShadow()}
15607 * so that your application can draw the shadow image in the Canvas.
15608 * </p>
Joe Fernandez558459f2011-10-13 16:47:36 -070015609 *
15610 * <div class="special reference">
15611 * <h3>Developer Guides</h3>
15612 * <p>For a guide to implementing drag and drop features, read the
15613 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p>
15614 * </div>
Christopher Tate2c095f32010-10-04 14:13:40 -070015615 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015616 public static class DragShadowBuilder {
Christopher Tatea0374192010-10-05 13:06:41 -070015617 private final WeakReference<View> mView;
Christopher Tate2c095f32010-10-04 14:13:40 -070015618
15619 /**
Joe Malin32736f02011-01-19 16:14:20 -080015620 * Constructs a shadow image builder based on a View. By default, the resulting drag
15621 * shadow will have the same appearance and dimensions as the View, with the touch point
15622 * over the center of the View.
15623 * @param view A View. Any View in scope can be used.
Christopher Tate2c095f32010-10-04 14:13:40 -070015624 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015625 public DragShadowBuilder(View view) {
Christopher Tatea0374192010-10-05 13:06:41 -070015626 mView = new WeakReference<View>(view);
Christopher Tate2c095f32010-10-04 14:13:40 -070015627 }
15628
Christopher Tate17ed60c2011-01-18 12:50:26 -080015629 /**
15630 * Construct a shadow builder object with no associated View. This
15631 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)}
15632 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order
15633 * to supply the drag shadow's dimensions and appearance without
Joe Malin32736f02011-01-19 16:14:20 -080015634 * reference to any View object. If they are not overridden, then the result is an
15635 * invisible drag shadow.
Christopher Tate17ed60c2011-01-18 12:50:26 -080015636 */
15637 public DragShadowBuilder() {
15638 mView = new WeakReference<View>(null);
15639 }
15640
15641 /**
15642 * Returns the View object that had been passed to the
15643 * {@link #View.DragShadowBuilder(View)}
15644 * constructor. If that View parameter was {@code null} or if the
15645 * {@link #View.DragShadowBuilder()}
15646 * constructor was used to instantiate the builder object, this method will return
15647 * null.
15648 *
15649 * @return The View object associate with this builder object.
15650 */
Romain Guy5c22a8c2011-05-13 11:48:45 -070015651 @SuppressWarnings({"JavadocReference"})
Chris Tate6b391282010-10-14 15:48:59 -070015652 final public View getView() {
15653 return mView.get();
15654 }
15655
Christopher Tate2c095f32010-10-04 14:13:40 -070015656 /**
Joe Malin32736f02011-01-19 16:14:20 -080015657 * Provides the metrics for the shadow image. These include the dimensions of
15658 * the shadow image, and the point within that shadow that should
Christopher Tate2c095f32010-10-04 14:13:40 -070015659 * be centered under the touch location while dragging.
15660 * <p>
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015661 * The default implementation sets the dimensions of the shadow to be the
Joe Malin32736f02011-01-19 16:14:20 -080015662 * same as the dimensions of the View itself and centers the shadow under
15663 * the touch point.
15664 * </p>
Christopher Tate2c095f32010-10-04 14:13:40 -070015665 *
Joe Malin32736f02011-01-19 16:14:20 -080015666 * @param shadowSize A {@link android.graphics.Point} containing the width and height
15667 * of the shadow image. Your application must set {@link android.graphics.Point#x} to the
15668 * desired width and must set {@link android.graphics.Point#y} to the desired height of the
15669 * image.
15670 *
15671 * @param shadowTouchPoint A {@link android.graphics.Point} for the position within the
15672 * shadow image that should be underneath the touch point during the drag and drop
15673 * operation. Your application must set {@link android.graphics.Point#x} to the
15674 * X coordinate and {@link android.graphics.Point#y} to the Y coordinate of this position.
Christopher Tate2c095f32010-10-04 14:13:40 -070015675 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015676 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) {
Christopher Tatea0374192010-10-05 13:06:41 -070015677 final View view = mView.get();
15678 if (view != null) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015679 shadowSize.set(view.getWidth(), view.getHeight());
15680 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2);
Christopher Tatea0374192010-10-05 13:06:41 -070015681 } else {
15682 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view");
15683 }
Christopher Tate2c095f32010-10-04 14:13:40 -070015684 }
15685
15686 /**
Joe Malin32736f02011-01-19 16:14:20 -080015687 * Draws the shadow image. The system creates the {@link android.graphics.Canvas} object
15688 * based on the dimensions it received from the
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015689 * {@link #onProvideShadowMetrics(Point, Point)} callback.
Christopher Tate2c095f32010-10-04 14:13:40 -070015690 *
Joe Malin32736f02011-01-19 16:14:20 -080015691 * @param canvas A {@link android.graphics.Canvas} object in which to draw the shadow image.
Christopher Tate2c095f32010-10-04 14:13:40 -070015692 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015693 public void onDrawShadow(Canvas canvas) {
Christopher Tatea0374192010-10-05 13:06:41 -070015694 final View view = mView.get();
15695 if (view != null) {
15696 view.draw(canvas);
15697 } else {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015698 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view");
Christopher Tatea0374192010-10-05 13:06:41 -070015699 }
Christopher Tate2c095f32010-10-04 14:13:40 -070015700 }
15701 }
15702
15703 /**
Joe Malin32736f02011-01-19 16:14:20 -080015704 * Starts a drag and drop operation. When your application calls this method, it passes a
15705 * {@link android.view.View.DragShadowBuilder} object to the system. The
15706 * system calls this object's {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)}
15707 * to get metrics for the drag shadow, and then calls the object's
15708 * {@link DragShadowBuilder#onDrawShadow(Canvas)} to draw the drag shadow itself.
15709 * <p>
15710 * Once the system has the drag shadow, it begins the drag and drop operation by sending
15711 * drag events to all the View objects in your application that are currently visible. It does
15712 * this either by calling the View object's drag listener (an implementation of
15713 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent) onDrag()} or by calling the
15714 * View object's {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} method.
15715 * Both are passed a {@link android.view.DragEvent} object that has a
15716 * {@link android.view.DragEvent#getAction()} value of
15717 * {@link android.view.DragEvent#ACTION_DRAG_STARTED}.
15718 * </p>
15719 * <p>
15720 * Your application can invoke startDrag() on any attached View object. The View object does not
15721 * need to be the one used in {@link android.view.View.DragShadowBuilder}, nor does it need to
15722 * be related to the View the user selected for dragging.
15723 * </p>
15724 * @param data A {@link android.content.ClipData} object pointing to the data to be
15725 * transferred by the drag and drop operation.
15726 * @param shadowBuilder A {@link android.view.View.DragShadowBuilder} object for building the
15727 * drag shadow.
15728 * @param myLocalState An {@link java.lang.Object} containing local data about the drag and
15729 * drop operation. This Object is put into every DragEvent object sent by the system during the
15730 * current drag.
15731 * <p>
15732 * myLocalState is a lightweight mechanism for the sending information from the dragged View
15733 * to the target Views. For example, it can contain flags that differentiate between a
15734 * a copy operation and a move operation.
15735 * </p>
15736 * @param flags Flags that control the drag and drop operation. No flags are currently defined,
15737 * so the parameter should be set to 0.
15738 * @return {@code true} if the method completes successfully, or
15739 * {@code false} if it fails anywhere. Returning {@code false} means the system was unable to
15740 * do a drag, and so no drag operation is in progress.
Christopher Tatea53146c2010-09-07 11:57:52 -070015741 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015742 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080015743 Object myLocalState, int flags) {
Christopher Tate2c095f32010-10-04 14:13:40 -070015744 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate02d2b3b2011-01-10 20:43:53 -080015745 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags);
Christopher Tatea53146c2010-09-07 11:57:52 -070015746 }
15747 boolean okay = false;
15748
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015749 Point shadowSize = new Point();
15750 Point shadowTouchPoint = new Point();
15751 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint);
Christopher Tate2c095f32010-10-04 14:13:40 -070015752
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015753 if ((shadowSize.x < 0) || (shadowSize.y < 0) ||
15754 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) {
15755 throw new IllegalStateException("Drag shadow dimensions must not be negative");
Christopher Tate2c095f32010-10-04 14:13:40 -070015756 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015757
Chris Tatea32dcf72010-10-14 12:13:50 -070015758 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015759 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y
15760 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y);
Chris Tatea32dcf72010-10-14 12:13:50 -070015761 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015762 Surface surface = new Surface();
15763 try {
15764 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080015765 flags, shadowSize.x, shadowSize.y, surface);
Christopher Tate2c095f32010-10-04 14:13:40 -070015766 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token
Christopher Tatea53146c2010-09-07 11:57:52 -070015767 + " surface=" + surface);
15768 if (token != null) {
15769 Canvas canvas = surface.lockCanvas(null);
Romain Guy0bb56672010-10-01 00:25:02 -070015770 try {
Chris Tate6b391282010-10-14 15:48:59 -070015771 canvas.drawColor(0, PorterDuff.Mode.CLEAR);
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015772 shadowBuilder.onDrawShadow(canvas);
Romain Guy0bb56672010-10-01 00:25:02 -070015773 } finally {
15774 surface.unlockCanvasAndPost(canvas);
15775 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015776
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070015777 final ViewRootImpl root = getViewRootImpl();
Christopher Tate407b4e92010-11-30 17:14:08 -080015778
15779 // Cache the local state object for delivery with DragEvents
15780 root.setLocalDragState(myLocalState);
15781
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015782 // repurpose 'shadowSize' for the last touch point
15783 root.getLastTouchPoint(shadowSize);
Christopher Tate2c095f32010-10-04 14:13:40 -070015784
Christopher Tatea53146c2010-09-07 11:57:52 -070015785 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token,
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015786 shadowSize.x, shadowSize.y,
15787 shadowTouchPoint.x, shadowTouchPoint.y, data);
Christopher Tate2c095f32010-10-04 14:13:40 -070015788 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay);
Christopher Tate8f73b5d2011-09-12 15:22:12 -070015789
15790 // Off and running! Release our local surface instance; the drag
15791 // shadow surface is now managed by the system process.
15792 surface.release();
Christopher Tatea53146c2010-09-07 11:57:52 -070015793 }
15794 } catch (Exception e) {
15795 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e);
15796 surface.destroy();
15797 }
15798
15799 return okay;
15800 }
15801
Christopher Tatea53146c2010-09-07 11:57:52 -070015802 /**
Joe Malin32736f02011-01-19 16:14:20 -080015803 * Handles drag events sent by the system following a call to
15804 * {@link android.view.View#startDrag(ClipData,DragShadowBuilder,Object,int) startDrag()}.
15805 *<p>
15806 * When the system calls this method, it passes a
15807 * {@link android.view.DragEvent} object. A call to
15808 * {@link android.view.DragEvent#getAction()} returns one of the action type constants defined
15809 * in DragEvent. The method uses these to determine what is happening in the drag and drop
15810 * operation.
15811 * @param event The {@link android.view.DragEvent} sent by the system.
15812 * The {@link android.view.DragEvent#getAction()} method returns an action type constant defined
15813 * in DragEvent, indicating the type of drag event represented by this object.
15814 * @return {@code true} if the method was successful, otherwise {@code false}.
15815 * <p>
15816 * The method should return {@code true} in response to an action type of
15817 * {@link android.view.DragEvent#ACTION_DRAG_STARTED} to receive drag events for the current
15818 * operation.
15819 * </p>
15820 * <p>
15821 * The method should also return {@code true} in response to an action type of
15822 * {@link android.view.DragEvent#ACTION_DROP} if it consumed the drop, or
15823 * {@code false} if it didn't.
15824 * </p>
Christopher Tatea53146c2010-09-07 11:57:52 -070015825 */
Christopher Tate5ada6cb2010-10-05 14:15:29 -070015826 public boolean onDragEvent(DragEvent event) {
Christopher Tatea53146c2010-09-07 11:57:52 -070015827 return false;
15828 }
15829
15830 /**
Joe Malin32736f02011-01-19 16:14:20 -080015831 * Detects if this View is enabled and has a drag event listener.
15832 * If both are true, then it calls the drag event listener with the
15833 * {@link android.view.DragEvent} it received. If the drag event listener returns
15834 * {@code true}, then dispatchDragEvent() returns {@code true}.
15835 * <p>
15836 * For all other cases, the method calls the
15837 * {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} drag event handler
15838 * method and returns its result.
15839 * </p>
15840 * <p>
15841 * This ensures that a drag event is always consumed, even if the View does not have a drag
15842 * event listener. However, if the View has a listener and the listener returns true, then
15843 * onDragEvent() is not called.
15844 * </p>
Christopher Tatea53146c2010-09-07 11:57:52 -070015845 */
15846 public boolean dispatchDragEvent(DragEvent event) {
Romain Guy676b1732011-02-14 14:45:33 -080015847 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070015848 ListenerInfo li = mListenerInfo;
15849 if (li != null && li.mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
15850 && li.mOnDragListener.onDrag(this, event)) {
Chris Tate32affef2010-10-18 15:29:21 -070015851 return true;
15852 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015853 return onDragEvent(event);
15854 }
15855
Christopher Tate3d4bf172011-03-28 16:16:46 -070015856 boolean canAcceptDrag() {
15857 return (mPrivateFlags2 & DRAG_CAN_ACCEPT) != 0;
15858 }
15859
Christopher Tatea53146c2010-09-07 11:57:52 -070015860 /**
Dianne Hackbornffa42482009-09-23 22:20:11 -070015861 * This needs to be a better API (NOT ON VIEW) before it is exposed. If
15862 * it is ever exposed at all.
Dianne Hackborn29e4a3c2009-09-30 22:35:40 -070015863 * @hide
Dianne Hackbornffa42482009-09-23 22:20:11 -070015864 */
15865 public void onCloseSystemDialogs(String reason) {
15866 }
Joe Malin32736f02011-01-19 16:14:20 -080015867
Dianne Hackbornffa42482009-09-23 22:20:11 -070015868 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015869 * Given a Drawable whose bounds have been set to draw into this view,
Romain Guy5c22a8c2011-05-13 11:48:45 -070015870 * update a Region being computed for
15871 * {@link #gatherTransparentRegion(android.graphics.Region)} so
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015872 * that any non-transparent parts of the Drawable are removed from the
15873 * given transparent region.
15874 *
15875 * @param dr The Drawable whose transparency is to be applied to the region.
15876 * @param region A Region holding the current transparency information,
15877 * where any parts of the region that are set are considered to be
15878 * transparent. On return, this region will be modified to have the
15879 * transparency information reduced by the corresponding parts of the
15880 * Drawable that are not transparent.
15881 * {@hide}
15882 */
15883 public void applyDrawableToTransparentRegion(Drawable dr, Region region) {
15884 if (DBG) {
15885 Log.i("View", "Getting transparent region for: " + this);
15886 }
15887 final Region r = dr.getTransparentRegion();
15888 final Rect db = dr.getBounds();
15889 final AttachInfo attachInfo = mAttachInfo;
15890 if (r != null && attachInfo != null) {
15891 final int w = getRight()-getLeft();
15892 final int h = getBottom()-getTop();
15893 if (db.left > 0) {
15894 //Log.i("VIEW", "Drawable left " + db.left + " > view 0");
15895 r.op(0, 0, db.left, h, Region.Op.UNION);
15896 }
15897 if (db.right < w) {
15898 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w);
15899 r.op(db.right, 0, w, h, Region.Op.UNION);
15900 }
15901 if (db.top > 0) {
15902 //Log.i("VIEW", "Drawable top " + db.top + " > view 0");
15903 r.op(0, 0, w, db.top, Region.Op.UNION);
15904 }
15905 if (db.bottom < h) {
15906 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h);
15907 r.op(0, db.bottom, w, h, Region.Op.UNION);
15908 }
15909 final int[] location = attachInfo.mTransparentLocation;
15910 getLocationInWindow(location);
15911 r.translate(location[0], location[1]);
15912 region.op(r, Region.Op.INTERSECT);
15913 } else {
15914 region.op(db, Region.Op.DIFFERENCE);
15915 }
15916 }
15917
Patrick Dubroye0a799a2011-05-04 16:19:22 -070015918 private void checkForLongClick(int delayOffset) {
15919 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
15920 mHasPerformedLongPress = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015921
Patrick Dubroye0a799a2011-05-04 16:19:22 -070015922 if (mPendingCheckForLongPress == null) {
15923 mPendingCheckForLongPress = new CheckForLongPress();
15924 }
15925 mPendingCheckForLongPress.rememberWindowAttachCount();
15926 postDelayed(mPendingCheckForLongPress,
15927 ViewConfiguration.getLongPressTimeout() - delayOffset);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015928 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015929 }
15930
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015931 /**
15932 * Inflate a view from an XML resource. This convenience method wraps the {@link
15933 * LayoutInflater} class, which provides a full range of options for view inflation.
15934 *
15935 * @param context The Context object for your activity or application.
15936 * @param resource The resource ID to inflate
15937 * @param root A view group that will be the parent. Used to properly inflate the
15938 * layout_* parameters.
15939 * @see LayoutInflater
15940 */
15941 public static View inflate(Context context, int resource, ViewGroup root) {
15942 LayoutInflater factory = LayoutInflater.from(context);
15943 return factory.inflate(resource, root);
15944 }
Romain Guy33e72ae2010-07-17 12:40:29 -070015945
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015946 /**
Adam Powell637d3372010-08-25 14:37:03 -070015947 * Scroll the view with standard behavior for scrolling beyond the normal
15948 * content boundaries. Views that call this method should override
15949 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the
15950 * results of an over-scroll operation.
15951 *
15952 * Views can use this method to handle any touch or fling-based scrolling.
15953 *
15954 * @param deltaX Change in X in pixels
15955 * @param deltaY Change in Y in pixels
15956 * @param scrollX Current X scroll value in pixels before applying deltaX
15957 * @param scrollY Current Y scroll value in pixels before applying deltaY
15958 * @param scrollRangeX Maximum content scroll range along the X axis
15959 * @param scrollRangeY Maximum content scroll range along the Y axis
15960 * @param maxOverScrollX Number of pixels to overscroll by in either direction
15961 * along the X axis.
15962 * @param maxOverScrollY Number of pixels to overscroll by in either direction
15963 * along the Y axis.
15964 * @param isTouchEvent true if this scroll operation is the result of a touch event.
15965 * @return true if scrolling was clamped to an over-scroll boundary along either
15966 * axis, false otherwise.
15967 */
Romain Guy7b5b6ab2011-03-14 18:05:08 -070015968 @SuppressWarnings({"UnusedParameters"})
Adam Powell637d3372010-08-25 14:37:03 -070015969 protected boolean overScrollBy(int deltaX, int deltaY,
15970 int scrollX, int scrollY,
15971 int scrollRangeX, int scrollRangeY,
15972 int maxOverScrollX, int maxOverScrollY,
15973 boolean isTouchEvent) {
15974 final int overScrollMode = mOverScrollMode;
15975 final boolean canScrollHorizontal =
15976 computeHorizontalScrollRange() > computeHorizontalScrollExtent();
15977 final boolean canScrollVertical =
15978 computeVerticalScrollRange() > computeVerticalScrollExtent();
15979 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS ||
15980 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal);
15981 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS ||
15982 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical);
15983
15984 int newScrollX = scrollX + deltaX;
15985 if (!overScrollHorizontal) {
15986 maxOverScrollX = 0;
15987 }
15988
15989 int newScrollY = scrollY + deltaY;
15990 if (!overScrollVertical) {
15991 maxOverScrollY = 0;
15992 }
15993
15994 // Clamp values if at the limits and record
15995 final int left = -maxOverScrollX;
15996 final int right = maxOverScrollX + scrollRangeX;
15997 final int top = -maxOverScrollY;
15998 final int bottom = maxOverScrollY + scrollRangeY;
15999
16000 boolean clampedX = false;
16001 if (newScrollX > right) {
16002 newScrollX = right;
16003 clampedX = true;
16004 } else if (newScrollX < left) {
16005 newScrollX = left;
16006 clampedX = true;
16007 }
16008
16009 boolean clampedY = false;
16010 if (newScrollY > bottom) {
16011 newScrollY = bottom;
16012 clampedY = true;
16013 } else if (newScrollY < top) {
16014 newScrollY = top;
16015 clampedY = true;
16016 }
16017
16018 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY);
16019
16020 return clampedX || clampedY;
16021 }
16022
16023 /**
16024 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to
16025 * respond to the results of an over-scroll operation.
16026 *
16027 * @param scrollX New X scroll value in pixels
16028 * @param scrollY New Y scroll value in pixels
16029 * @param clampedX True if scrollX was clamped to an over-scroll boundary
16030 * @param clampedY True if scrollY was clamped to an over-scroll boundary
16031 */
16032 protected void onOverScrolled(int scrollX, int scrollY,
16033 boolean clampedX, boolean clampedY) {
16034 // Intentionally empty.
16035 }
16036
16037 /**
16038 * Returns the over-scroll mode for this view. The result will be
16039 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
16040 * (allow over-scrolling only if the view content is larger than the container),
16041 * or {@link #OVER_SCROLL_NEVER}.
16042 *
16043 * @return This view's over-scroll mode.
16044 */
16045 public int getOverScrollMode() {
16046 return mOverScrollMode;
16047 }
16048
16049 /**
16050 * Set the over-scroll mode for this view. Valid over-scroll modes are
16051 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
16052 * (allow over-scrolling only if the view content is larger than the container),
16053 * or {@link #OVER_SCROLL_NEVER}.
16054 *
16055 * Setting the over-scroll mode of a view will have an effect only if the
16056 * view is capable of scrolling.
16057 *
16058 * @param overScrollMode The new over-scroll mode for this view.
16059 */
16060 public void setOverScrollMode(int overScrollMode) {
16061 if (overScrollMode != OVER_SCROLL_ALWAYS &&
16062 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS &&
16063 overScrollMode != OVER_SCROLL_NEVER) {
16064 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode);
16065 }
16066 mOverScrollMode = overScrollMode;
16067 }
16068
16069 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -080016070 * Gets a scale factor that determines the distance the view should scroll
16071 * vertically in response to {@link MotionEvent#ACTION_SCROLL}.
16072 * @return The vertical scroll scale factor.
16073 * @hide
16074 */
16075 protected float getVerticalScrollFactor() {
16076 if (mVerticalScrollFactor == 0) {
16077 TypedValue outValue = new TypedValue();
16078 if (!mContext.getTheme().resolveAttribute(
16079 com.android.internal.R.attr.listPreferredItemHeight, outValue, true)) {
16080 throw new IllegalStateException(
16081 "Expected theme to define listPreferredItemHeight.");
16082 }
16083 mVerticalScrollFactor = outValue.getDimension(
16084 mContext.getResources().getDisplayMetrics());
16085 }
16086 return mVerticalScrollFactor;
16087 }
16088
16089 /**
16090 * Gets a scale factor that determines the distance the view should scroll
16091 * horizontally in response to {@link MotionEvent#ACTION_SCROLL}.
16092 * @return The horizontal scroll scale factor.
16093 * @hide
16094 */
16095 protected float getHorizontalScrollFactor() {
16096 // TODO: Should use something else.
16097 return getVerticalScrollFactor();
16098 }
16099
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016100 /**
16101 * Return the value specifying the text direction or policy that was set with
16102 * {@link #setTextDirection(int)}.
16103 *
16104 * @return the defined text direction. It can be one of:
16105 *
16106 * {@link #TEXT_DIRECTION_INHERIT},
16107 * {@link #TEXT_DIRECTION_FIRST_STRONG}
16108 * {@link #TEXT_DIRECTION_ANY_RTL},
16109 * {@link #TEXT_DIRECTION_LTR},
16110 * {@link #TEXT_DIRECTION_RTL},
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016111 * {@link #TEXT_DIRECTION_LOCALE}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016112 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016113 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016114 @ViewDebug.ExportedProperty(category = "text", mapping = {
16115 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"),
16116 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"),
16117 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"),
16118 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"),
16119 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL"),
16120 @ViewDebug.IntToString(from = TEXT_DIRECTION_LOCALE, to = "LOCALE")
16121 })
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016122 public int getTextDirection() {
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016123 return (mPrivateFlags2 & TEXT_DIRECTION_MASK) >> TEXT_DIRECTION_MASK_SHIFT;
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016124 }
16125
16126 /**
16127 * Set the text direction.
16128 *
16129 * @param textDirection the direction to set. Should be one of:
16130 *
16131 * {@link #TEXT_DIRECTION_INHERIT},
16132 * {@link #TEXT_DIRECTION_FIRST_STRONG}
16133 * {@link #TEXT_DIRECTION_ANY_RTL},
16134 * {@link #TEXT_DIRECTION_LTR},
16135 * {@link #TEXT_DIRECTION_RTL},
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016136 * {@link #TEXT_DIRECTION_LOCALE}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016137 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016138 */
16139 public void setTextDirection(int textDirection) {
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016140 if (getTextDirection() != textDirection) {
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -070016141 // Reset the current text direction and the resolved one
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016142 mPrivateFlags2 &= ~TEXT_DIRECTION_MASK;
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -070016143 resetResolvedTextDirection();
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016144 // Set the new text direction
16145 mPrivateFlags2 |= ((textDirection << TEXT_DIRECTION_MASK_SHIFT) & TEXT_DIRECTION_MASK);
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016146 // Refresh
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016147 requestLayout();
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -070016148 invalidate(true);
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016149 }
16150 }
16151
16152 /**
16153 * Return the resolved text direction.
16154 *
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016155 * This needs resolution if the value is TEXT_DIRECTION_INHERIT. The resolution matches
16156 * {@link #getTextDirection()}if it is not TEXT_DIRECTION_INHERIT, otherwise resolution proceeds
16157 * up the parent chain of the view. if there is no parent, then it will return the default
16158 * {@link #TEXT_DIRECTION_FIRST_STRONG}.
16159 *
16160 * @return the resolved text direction. Returns one of:
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016161 *
Doug Feltcb3791202011-07-07 11:57:48 -070016162 * {@link #TEXT_DIRECTION_FIRST_STRONG}
16163 * {@link #TEXT_DIRECTION_ANY_RTL},
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016164 * {@link #TEXT_DIRECTION_LTR},
16165 * {@link #TEXT_DIRECTION_RTL},
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016166 * {@link #TEXT_DIRECTION_LOCALE}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016167 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016168 */
16169 public int getResolvedTextDirection() {
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070016170 // The text direction will be resolved only if needed
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016171 if ((mPrivateFlags2 & TEXT_DIRECTION_RESOLVED) != TEXT_DIRECTION_RESOLVED) {
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016172 resolveTextDirection();
16173 }
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016174 return (mPrivateFlags2 & TEXT_DIRECTION_RESOLVED_MASK) >> TEXT_DIRECTION_RESOLVED_MASK_SHIFT;
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016175 }
16176
16177 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016178 * Resolve the text direction. Will call {@link View#onResolvedTextDirectionChanged} when
16179 * resolution is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016180 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016181 */
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016182 public void resolveTextDirection() {
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016183 // Reset any previous text direction resolution
16184 mPrivateFlags2 &= ~(TEXT_DIRECTION_RESOLVED | TEXT_DIRECTION_RESOLVED_MASK);
16185
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016186 if (hasRtlSupport()) {
16187 // Set resolved text direction flag depending on text direction flag
16188 final int textDirection = getTextDirection();
16189 switch(textDirection) {
16190 case TEXT_DIRECTION_INHERIT:
16191 if (canResolveTextDirection()) {
16192 ViewGroup viewGroup = ((ViewGroup) mParent);
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016193
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016194 // Set current resolved direction to the same value as the parent's one
16195 final int parentResolvedDirection = viewGroup.getResolvedTextDirection();
16196 switch (parentResolvedDirection) {
16197 case TEXT_DIRECTION_FIRST_STRONG:
16198 case TEXT_DIRECTION_ANY_RTL:
16199 case TEXT_DIRECTION_LTR:
16200 case TEXT_DIRECTION_RTL:
16201 case TEXT_DIRECTION_LOCALE:
16202 mPrivateFlags2 |=
16203 (parentResolvedDirection << TEXT_DIRECTION_RESOLVED_MASK_SHIFT);
16204 break;
16205 default:
16206 // Default resolved direction is "first strong" heuristic
16207 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT;
16208 }
16209 } else {
16210 // We cannot do the resolution if there is no parent, so use the default one
16211 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT;
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016212 }
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016213 break;
16214 case TEXT_DIRECTION_FIRST_STRONG:
16215 case TEXT_DIRECTION_ANY_RTL:
16216 case TEXT_DIRECTION_LTR:
16217 case TEXT_DIRECTION_RTL:
16218 case TEXT_DIRECTION_LOCALE:
16219 // Resolved direction is the same as text direction
16220 mPrivateFlags2 |= (textDirection << TEXT_DIRECTION_RESOLVED_MASK_SHIFT);
16221 break;
16222 default:
16223 // Default resolved direction is "first strong" heuristic
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016224 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT;
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016225 }
16226 } else {
16227 // Default resolved direction is "first strong" heuristic
16228 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT;
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016229 }
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016230
16231 // Set to resolved
16232 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED;
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016233 onResolvedTextDirectionChanged();
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016234 }
16235
16236 /**
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016237 * Called when text direction has been resolved. Subclasses that care about text direction
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016238 * resolution should override this method.
16239 *
16240 * The default implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016241 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016242 */
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016243 public void onResolvedTextDirectionChanged() {
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016244 }
16245
16246 /**
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016247 * Check if text direction resolution can be done.
16248 *
16249 * @return true if text direction resolution can be done otherwise return false.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016250 * @hide
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016251 */
16252 public boolean canResolveTextDirection() {
16253 switch (getTextDirection()) {
16254 case TEXT_DIRECTION_INHERIT:
16255 return (mParent != null) && (mParent instanceof ViewGroup);
16256 default:
16257 return true;
16258 }
16259 }
16260
16261 /**
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016262 * Reset resolved text direction. Text direction can be resolved with a call to
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016263 * getResolvedTextDirection(). Will call {@link View#onResolvedTextDirectionReset} when
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016264 * reset is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016265 * @hide
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016266 */
16267 public void resetResolvedTextDirection() {
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016268 mPrivateFlags2 &= ~(TEXT_DIRECTION_RESOLVED | TEXT_DIRECTION_RESOLVED_MASK);
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016269 onResolvedTextDirectionReset();
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016270 }
16271
16272 /**
16273 * Called when text direction is reset. Subclasses that care about text direction reset should
16274 * override this method and do a reset of the text direction of their children. The default
16275 * implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016276 * @hide
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016277 */
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016278 public void onResolvedTextDirectionReset() {
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016279 }
16280
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016281 /**
16282 * Return the value specifying the text alignment or policy that was set with
16283 * {@link #setTextAlignment(int)}.
16284 *
16285 * @return the defined text alignment. It can be one of:
16286 *
16287 * {@link #TEXT_ALIGNMENT_INHERIT},
16288 * {@link #TEXT_ALIGNMENT_GRAVITY},
16289 * {@link #TEXT_ALIGNMENT_CENTER},
16290 * {@link #TEXT_ALIGNMENT_TEXT_START},
16291 * {@link #TEXT_ALIGNMENT_TEXT_END},
16292 * {@link #TEXT_ALIGNMENT_VIEW_START},
16293 * {@link #TEXT_ALIGNMENT_VIEW_END}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016294 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016295 */
16296 @ViewDebug.ExportedProperty(category = "text", mapping = {
16297 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"),
16298 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"),
16299 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"),
16300 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"),
16301 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"),
16302 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"),
16303 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END")
16304 })
16305 public int getTextAlignment() {
16306 return (mPrivateFlags2 & TEXT_ALIGNMENT_MASK) >> TEXT_ALIGNMENT_MASK_SHIFT;
16307 }
16308
16309 /**
16310 * Set the text alignment.
16311 *
16312 * @param textAlignment The text alignment to set. Should be one of
16313 *
16314 * {@link #TEXT_ALIGNMENT_INHERIT},
16315 * {@link #TEXT_ALIGNMENT_GRAVITY},
16316 * {@link #TEXT_ALIGNMENT_CENTER},
16317 * {@link #TEXT_ALIGNMENT_TEXT_START},
16318 * {@link #TEXT_ALIGNMENT_TEXT_END},
16319 * {@link #TEXT_ALIGNMENT_VIEW_START},
16320 * {@link #TEXT_ALIGNMENT_VIEW_END}
16321 *
16322 * @attr ref android.R.styleable#View_textAlignment
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016323 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016324 */
16325 public void setTextAlignment(int textAlignment) {
16326 if (textAlignment != getTextAlignment()) {
16327 // Reset the current and resolved text alignment
16328 mPrivateFlags2 &= ~TEXT_ALIGNMENT_MASK;
16329 resetResolvedTextAlignment();
16330 // Set the new text alignment
16331 mPrivateFlags2 |= ((textAlignment << TEXT_ALIGNMENT_MASK_SHIFT) & TEXT_ALIGNMENT_MASK);
16332 // Refresh
16333 requestLayout();
16334 invalidate(true);
16335 }
16336 }
16337
16338 /**
16339 * Return the resolved text alignment.
16340 *
16341 * The resolved text alignment. This needs resolution if the value is
16342 * TEXT_ALIGNMENT_INHERIT. The resolution matches {@link #setTextAlignment(int)} if it is
16343 * not TEXT_ALIGNMENT_INHERIT, otherwise resolution proceeds up the parent chain of the view.
16344 *
16345 * @return the resolved text alignment. Returns one of:
16346 *
16347 * {@link #TEXT_ALIGNMENT_GRAVITY},
16348 * {@link #TEXT_ALIGNMENT_CENTER},
16349 * {@link #TEXT_ALIGNMENT_TEXT_START},
16350 * {@link #TEXT_ALIGNMENT_TEXT_END},
16351 * {@link #TEXT_ALIGNMENT_VIEW_START},
16352 * {@link #TEXT_ALIGNMENT_VIEW_END}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016353 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016354 */
16355 @ViewDebug.ExportedProperty(category = "text", mapping = {
16356 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"),
16357 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"),
16358 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"),
16359 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"),
16360 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"),
16361 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"),
16362 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END")
16363 })
16364 public int getResolvedTextAlignment() {
16365 // If text alignment is not resolved, then resolve it
16366 if ((mPrivateFlags2 & TEXT_ALIGNMENT_RESOLVED) != TEXT_ALIGNMENT_RESOLVED) {
16367 resolveTextAlignment();
16368 }
16369 return (mPrivateFlags2 & TEXT_ALIGNMENT_RESOLVED_MASK) >> TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT;
16370 }
16371
16372 /**
16373 * Resolve the text alignment. Will call {@link View#onResolvedTextAlignmentChanged} when
16374 * resolution is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016375 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016376 */
16377 public void resolveTextAlignment() {
16378 // Reset any previous text alignment resolution
16379 mPrivateFlags2 &= ~(TEXT_ALIGNMENT_RESOLVED | TEXT_ALIGNMENT_RESOLVED_MASK);
16380
16381 if (hasRtlSupport()) {
16382 // Set resolved text alignment flag depending on text alignment flag
16383 final int textAlignment = getTextAlignment();
16384 switch (textAlignment) {
16385 case TEXT_ALIGNMENT_INHERIT:
16386 // Check if we can resolve the text alignment
16387 if (canResolveLayoutDirection() && mParent instanceof View) {
16388 View view = (View) mParent;
16389
16390 final int parentResolvedTextAlignment = view.getResolvedTextAlignment();
16391 switch (parentResolvedTextAlignment) {
16392 case TEXT_ALIGNMENT_GRAVITY:
16393 case TEXT_ALIGNMENT_TEXT_START:
16394 case TEXT_ALIGNMENT_TEXT_END:
16395 case TEXT_ALIGNMENT_CENTER:
16396 case TEXT_ALIGNMENT_VIEW_START:
16397 case TEXT_ALIGNMENT_VIEW_END:
16398 // Resolved text alignment is the same as the parent resolved
16399 // text alignment
16400 mPrivateFlags2 |=
16401 (parentResolvedTextAlignment << TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT);
16402 break;
16403 default:
16404 // Use default resolved text alignment
16405 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT;
16406 }
16407 }
16408 else {
16409 // We cannot do the resolution if there is no parent so use the default
16410 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT;
16411 }
16412 break;
16413 case TEXT_ALIGNMENT_GRAVITY:
16414 case TEXT_ALIGNMENT_TEXT_START:
16415 case TEXT_ALIGNMENT_TEXT_END:
16416 case TEXT_ALIGNMENT_CENTER:
16417 case TEXT_ALIGNMENT_VIEW_START:
16418 case TEXT_ALIGNMENT_VIEW_END:
16419 // Resolved text alignment is the same as text alignment
16420 mPrivateFlags2 |= (textAlignment << TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT);
16421 break;
16422 default:
16423 // Use default resolved text alignment
16424 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT;
16425 }
16426 } else {
16427 // Use default resolved text alignment
16428 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT;
16429 }
16430
16431 // Set the resolved
16432 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED;
16433 onResolvedTextAlignmentChanged();
16434 }
16435
16436 /**
16437 * Check if text alignment resolution can be done.
16438 *
16439 * @return true if text alignment resolution can be done otherwise return false.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016440 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016441 */
16442 public boolean canResolveTextAlignment() {
16443 switch (getTextAlignment()) {
16444 case TEXT_DIRECTION_INHERIT:
16445 return (mParent != null);
16446 default:
16447 return true;
16448 }
16449 }
16450
16451 /**
16452 * Called when text alignment has been resolved. Subclasses that care about text alignment
16453 * resolution should override this method.
16454 *
16455 * The default implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016456 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016457 */
16458 public void onResolvedTextAlignmentChanged() {
16459 }
16460
16461 /**
16462 * Reset resolved text alignment. Text alignment can be resolved with a call to
16463 * getResolvedTextAlignment(). Will call {@link View#onResolvedTextAlignmentReset} when
16464 * reset is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016465 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016466 */
16467 public void resetResolvedTextAlignment() {
16468 // Reset any previous text alignment resolution
16469 mPrivateFlags2 &= ~(TEXT_ALIGNMENT_RESOLVED | TEXT_ALIGNMENT_RESOLVED_MASK);
16470 onResolvedTextAlignmentReset();
16471 }
16472
16473 /**
16474 * Called when text alignment is reset. Subclasses that care about text alignment reset should
16475 * override this method and do a reset of the text alignment of their children. The default
16476 * implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016477 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016478 */
16479 public void onResolvedTextAlignmentReset() {
16480 }
16481
Chet Haaseb39f0512011-05-24 14:36:40 -070016482 //
16483 // Properties
16484 //
16485 /**
16486 * A Property wrapper around the <code>alpha</code> functionality handled by the
16487 * {@link View#setAlpha(float)} and {@link View#getAlpha()} methods.
16488 */
Chet Haased47f1532011-12-16 11:18:52 -080016489 public static final Property<View, Float> ALPHA = new FloatProperty<View>("alpha") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016490 @Override
16491 public void setValue(View object, float value) {
16492 object.setAlpha(value);
16493 }
16494
16495 @Override
16496 public Float get(View object) {
16497 return object.getAlpha();
16498 }
16499 };
16500
16501 /**
16502 * A Property wrapper around the <code>translationX</code> functionality handled by the
16503 * {@link View#setTranslationX(float)} and {@link View#getTranslationX()} methods.
16504 */
Chet Haased47f1532011-12-16 11:18:52 -080016505 public static final Property<View, Float> TRANSLATION_X = new FloatProperty<View>("translationX") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016506 @Override
16507 public void setValue(View object, float value) {
16508 object.setTranslationX(value);
16509 }
16510
16511 @Override
16512 public Float get(View object) {
16513 return object.getTranslationX();
16514 }
16515 };
16516
16517 /**
16518 * A Property wrapper around the <code>translationY</code> functionality handled by the
16519 * {@link View#setTranslationY(float)} and {@link View#getTranslationY()} methods.
16520 */
Chet Haased47f1532011-12-16 11:18:52 -080016521 public static final Property<View, Float> TRANSLATION_Y = new FloatProperty<View>("translationY") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016522 @Override
16523 public void setValue(View object, float value) {
16524 object.setTranslationY(value);
16525 }
16526
16527 @Override
16528 public Float get(View object) {
16529 return object.getTranslationY();
16530 }
16531 };
16532
16533 /**
16534 * A Property wrapper around the <code>x</code> functionality handled by the
16535 * {@link View#setX(float)} and {@link View#getX()} methods.
16536 */
Chet Haased47f1532011-12-16 11:18:52 -080016537 public static final Property<View, Float> X = new FloatProperty<View>("x") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016538 @Override
16539 public void setValue(View object, float value) {
16540 object.setX(value);
16541 }
16542
16543 @Override
16544 public Float get(View object) {
16545 return object.getX();
16546 }
16547 };
16548
16549 /**
16550 * A Property wrapper around the <code>y</code> functionality handled by the
16551 * {@link View#setY(float)} and {@link View#getY()} methods.
16552 */
Chet Haased47f1532011-12-16 11:18:52 -080016553 public static final Property<View, Float> Y = new FloatProperty<View>("y") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016554 @Override
16555 public void setValue(View object, float value) {
16556 object.setY(value);
16557 }
16558
16559 @Override
16560 public Float get(View object) {
16561 return object.getY();
16562 }
16563 };
16564
16565 /**
16566 * A Property wrapper around the <code>rotation</code> functionality handled by the
16567 * {@link View#setRotation(float)} and {@link View#getRotation()} methods.
16568 */
Chet Haased47f1532011-12-16 11:18:52 -080016569 public static final Property<View, Float> ROTATION = new FloatProperty<View>("rotation") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016570 @Override
16571 public void setValue(View object, float value) {
16572 object.setRotation(value);
16573 }
16574
16575 @Override
16576 public Float get(View object) {
16577 return object.getRotation();
16578 }
16579 };
16580
16581 /**
16582 * A Property wrapper around the <code>rotationX</code> functionality handled by the
16583 * {@link View#setRotationX(float)} and {@link View#getRotationX()} methods.
16584 */
Chet Haased47f1532011-12-16 11:18:52 -080016585 public static final Property<View, Float> ROTATION_X = new FloatProperty<View>("rotationX") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016586 @Override
16587 public void setValue(View object, float value) {
16588 object.setRotationX(value);
16589 }
16590
16591 @Override
16592 public Float get(View object) {
16593 return object.getRotationX();
16594 }
16595 };
16596
16597 /**
16598 * A Property wrapper around the <code>rotationY</code> functionality handled by the
16599 * {@link View#setRotationY(float)} and {@link View#getRotationY()} methods.
16600 */
Chet Haased47f1532011-12-16 11:18:52 -080016601 public static final Property<View, Float> ROTATION_Y = new FloatProperty<View>("rotationY") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016602 @Override
16603 public void setValue(View object, float value) {
16604 object.setRotationY(value);
16605 }
16606
16607 @Override
16608 public Float get(View object) {
16609 return object.getRotationY();
16610 }
16611 };
16612
16613 /**
16614 * A Property wrapper around the <code>scaleX</code> functionality handled by the
16615 * {@link View#setScaleX(float)} and {@link View#getScaleX()} methods.
16616 */
Chet Haased47f1532011-12-16 11:18:52 -080016617 public static final Property<View, Float> SCALE_X = new FloatProperty<View>("scaleX") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016618 @Override
16619 public void setValue(View object, float value) {
16620 object.setScaleX(value);
16621 }
16622
16623 @Override
16624 public Float get(View object) {
16625 return object.getScaleX();
16626 }
16627 };
16628
16629 /**
16630 * A Property wrapper around the <code>scaleY</code> functionality handled by the
16631 * {@link View#setScaleY(float)} and {@link View#getScaleY()} methods.
16632 */
Chet Haased47f1532011-12-16 11:18:52 -080016633 public static final Property<View, Float> SCALE_Y = new FloatProperty<View>("scaleY") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016634 @Override
16635 public void setValue(View object, float value) {
16636 object.setScaleY(value);
16637 }
16638
16639 @Override
16640 public Float get(View object) {
16641 return object.getScaleY();
16642 }
16643 };
16644
Jeff Brown33bbfd22011-02-24 20:55:35 -080016645 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016646 * A MeasureSpec encapsulates the layout requirements passed from parent to child.
16647 * Each MeasureSpec represents a requirement for either the width or the height.
16648 * A MeasureSpec is comprised of a size and a mode. There are three possible
16649 * modes:
16650 * <dl>
16651 * <dt>UNSPECIFIED</dt>
16652 * <dd>
16653 * The parent has not imposed any constraint on the child. It can be whatever size
16654 * it wants.
16655 * </dd>
16656 *
16657 * <dt>EXACTLY</dt>
16658 * <dd>
16659 * The parent has determined an exact size for the child. The child is going to be
16660 * given those bounds regardless of how big it wants to be.
16661 * </dd>
16662 *
16663 * <dt>AT_MOST</dt>
16664 * <dd>
16665 * The child can be as large as it wants up to the specified size.
16666 * </dd>
16667 * </dl>
16668 *
16669 * MeasureSpecs are implemented as ints to reduce object allocation. This class
16670 * is provided to pack and unpack the &lt;size, mode&gt; tuple into the int.
16671 */
16672 public static class MeasureSpec {
16673 private static final int MODE_SHIFT = 30;
16674 private static final int MODE_MASK = 0x3 << MODE_SHIFT;
16675
16676 /**
16677 * Measure specification mode: The parent has not imposed any constraint
16678 * on the child. It can be whatever size it wants.
16679 */
16680 public static final int UNSPECIFIED = 0 << MODE_SHIFT;
16681
16682 /**
16683 * Measure specification mode: The parent has determined an exact size
16684 * for the child. The child is going to be given those bounds regardless
16685 * of how big it wants to be.
16686 */
16687 public static final int EXACTLY = 1 << MODE_SHIFT;
16688
16689 /**
16690 * Measure specification mode: The child can be as large as it wants up
16691 * to the specified size.
16692 */
16693 public static final int AT_MOST = 2 << MODE_SHIFT;
16694
16695 /**
16696 * Creates a measure specification based on the supplied size and mode.
16697 *
16698 * The mode must always be one of the following:
16699 * <ul>
16700 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li>
16701 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li>
16702 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li>
16703 * </ul>
16704 *
16705 * @param size the size of the measure specification
16706 * @param mode the mode of the measure specification
16707 * @return the measure specification based on size and mode
16708 */
16709 public static int makeMeasureSpec(int size, int mode) {
16710 return size + mode;
16711 }
16712
16713 /**
16714 * Extracts the mode from the supplied measure specification.
16715 *
16716 * @param measureSpec the measure specification to extract the mode from
16717 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED},
16718 * {@link android.view.View.MeasureSpec#AT_MOST} or
16719 * {@link android.view.View.MeasureSpec#EXACTLY}
16720 */
16721 public static int getMode(int measureSpec) {
16722 return (measureSpec & MODE_MASK);
16723 }
16724
16725 /**
16726 * Extracts the size from the supplied measure specification.
16727 *
16728 * @param measureSpec the measure specification to extract the size from
16729 * @return the size in pixels defined in the supplied measure specification
16730 */
16731 public static int getSize(int measureSpec) {
16732 return (measureSpec & ~MODE_MASK);
16733 }
16734
16735 /**
16736 * Returns a String representation of the specified measure
16737 * specification.
16738 *
16739 * @param measureSpec the measure specification to convert to a String
16740 * @return a String with the following format: "MeasureSpec: MODE SIZE"
16741 */
16742 public static String toString(int measureSpec) {
16743 int mode = getMode(measureSpec);
16744 int size = getSize(measureSpec);
16745
16746 StringBuilder sb = new StringBuilder("MeasureSpec: ");
16747
16748 if (mode == UNSPECIFIED)
16749 sb.append("UNSPECIFIED ");
16750 else if (mode == EXACTLY)
16751 sb.append("EXACTLY ");
16752 else if (mode == AT_MOST)
16753 sb.append("AT_MOST ");
16754 else
16755 sb.append(mode).append(" ");
16756
16757 sb.append(size);
16758 return sb.toString();
16759 }
16760 }
16761
16762 class CheckForLongPress implements Runnable {
16763
16764 private int mOriginalWindowAttachCount;
16765
16766 public void run() {
The Android Open Source Project10592532009-03-18 17:39:46 -070016767 if (isPressed() && (mParent != null)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016768 && mOriginalWindowAttachCount == mWindowAttachCount) {
16769 if (performLongClick()) {
16770 mHasPerformedLongPress = true;
16771 }
16772 }
16773 }
16774
16775 public void rememberWindowAttachCount() {
16776 mOriginalWindowAttachCount = mWindowAttachCount;
16777 }
16778 }
Joe Malin32736f02011-01-19 16:14:20 -080016779
Adam Powelle14579b2009-12-16 18:39:52 -080016780 private final class CheckForTap implements Runnable {
16781 public void run() {
16782 mPrivateFlags &= ~PREPRESSED;
Adam Powell4d6f0662012-02-21 15:11:11 -080016783 setPressed(true);
Patrick Dubroye0a799a2011-05-04 16:19:22 -070016784 checkForLongClick(ViewConfiguration.getTapTimeout());
Adam Powelle14579b2009-12-16 18:39:52 -080016785 }
16786 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016787
Adam Powella35d7682010-03-12 14:48:13 -080016788 private final class PerformClick implements Runnable {
16789 public void run() {
16790 performClick();
16791 }
16792 }
16793
Dianne Hackborn63042d62011-01-26 18:56:29 -080016794 /** @hide */
16795 public void hackTurnOffWindowResizeAnim(boolean off) {
16796 mAttachInfo.mTurnOffWindowResizeAnim = off;
16797 }
Joe Malin32736f02011-01-19 16:14:20 -080016798
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016799 /**
Chet Haasea00f3862011-02-22 06:34:40 -080016800 * This method returns a ViewPropertyAnimator object, which can be used to animate
16801 * specific properties on this View.
16802 *
16803 * @return ViewPropertyAnimator The ViewPropertyAnimator associated with this View.
16804 */
16805 public ViewPropertyAnimator animate() {
16806 if (mAnimator == null) {
16807 mAnimator = new ViewPropertyAnimator(this);
16808 }
16809 return mAnimator;
16810 }
16811
16812 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016813 * Interface definition for a callback to be invoked when a key event is
16814 * dispatched to this view. The callback will be invoked before the key
16815 * event is given to the view.
16816 */
16817 public interface OnKeyListener {
16818 /**
16819 * Called when a key is dispatched to a view. This allows listeners to
16820 * get a chance to respond before the target view.
16821 *
16822 * @param v The view the key has been dispatched to.
16823 * @param keyCode The code for the physical key that was pressed
16824 * @param event The KeyEvent object containing full information about
16825 * the event.
16826 * @return True if the listener has consumed the event, false otherwise.
16827 */
16828 boolean onKey(View v, int keyCode, KeyEvent event);
16829 }
16830
16831 /**
16832 * Interface definition for a callback to be invoked when a touch event is
16833 * dispatched to this view. The callback will be invoked before the touch
16834 * event is given to the view.
16835 */
16836 public interface OnTouchListener {
16837 /**
16838 * Called when a touch event is dispatched to a view. This allows listeners to
16839 * get a chance to respond before the target view.
16840 *
16841 * @param v The view the touch event has been dispatched to.
16842 * @param event The MotionEvent object containing full information about
16843 * the event.
16844 * @return True if the listener has consumed the event, false otherwise.
16845 */
16846 boolean onTouch(View v, MotionEvent event);
16847 }
16848
16849 /**
Jeff Brown10b62902011-06-20 16:40:37 -070016850 * Interface definition for a callback to be invoked when a hover event is
16851 * dispatched to this view. The callback will be invoked before the hover
16852 * event is given to the view.
16853 */
16854 public interface OnHoverListener {
16855 /**
16856 * Called when a hover event is dispatched to a view. This allows listeners to
16857 * get a chance to respond before the target view.
16858 *
16859 * @param v The view the hover event has been dispatched to.
16860 * @param event The MotionEvent object containing full information about
16861 * the event.
16862 * @return True if the listener has consumed the event, false otherwise.
16863 */
16864 boolean onHover(View v, MotionEvent event);
16865 }
16866
16867 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -080016868 * Interface definition for a callback to be invoked when a generic motion event is
16869 * dispatched to this view. The callback will be invoked before the generic motion
16870 * event is given to the view.
16871 */
16872 public interface OnGenericMotionListener {
16873 /**
16874 * Called when a generic motion event is dispatched to a view. This allows listeners to
16875 * get a chance to respond before the target view.
16876 *
16877 * @param v The view the generic motion event has been dispatched to.
16878 * @param event The MotionEvent object containing full information about
16879 * the event.
16880 * @return True if the listener has consumed the event, false otherwise.
16881 */
16882 boolean onGenericMotion(View v, MotionEvent event);
16883 }
16884
16885 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016886 * Interface definition for a callback to be invoked when a view has been clicked and held.
16887 */
16888 public interface OnLongClickListener {
16889 /**
16890 * Called when a view has been clicked and held.
16891 *
16892 * @param v The view that was clicked and held.
16893 *
Brad Fitzpatrick69ea4e12011-01-05 11:13:40 -080016894 * @return true if the callback consumed the long click, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016895 */
16896 boolean onLongClick(View v);
16897 }
16898
16899 /**
Chris Tate32affef2010-10-18 15:29:21 -070016900 * Interface definition for a callback to be invoked when a drag is being dispatched
16901 * to this view. The callback will be invoked before the hosting view's own
16902 * onDrag(event) method. If the listener wants to fall back to the hosting view's
16903 * onDrag(event) behavior, it should return 'false' from this callback.
Joe Fernandez558459f2011-10-13 16:47:36 -070016904 *
16905 * <div class="special reference">
16906 * <h3>Developer Guides</h3>
16907 * <p>For a guide to implementing drag and drop features, read the
16908 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p>
16909 * </div>
Chris Tate32affef2010-10-18 15:29:21 -070016910 */
16911 public interface OnDragListener {
16912 /**
16913 * Called when a drag event is dispatched to a view. This allows listeners
16914 * to get a chance to override base View behavior.
16915 *
Joe Malin32736f02011-01-19 16:14:20 -080016916 * @param v The View that received the drag event.
16917 * @param event The {@link android.view.DragEvent} object for the drag event.
16918 * @return {@code true} if the drag event was handled successfully, or {@code false}
16919 * if the drag event was not handled. Note that {@code false} will trigger the View
16920 * to call its {@link #onDragEvent(DragEvent) onDragEvent()} handler.
Chris Tate32affef2010-10-18 15:29:21 -070016921 */
16922 boolean onDrag(View v, DragEvent event);
16923 }
16924
16925 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016926 * Interface definition for a callback to be invoked when the focus state of
16927 * a view changed.
16928 */
16929 public interface OnFocusChangeListener {
16930 /**
16931 * Called when the focus state of a view has changed.
16932 *
16933 * @param v The view whose state has changed.
16934 * @param hasFocus The new focus state of v.
16935 */
16936 void onFocusChange(View v, boolean hasFocus);
16937 }
16938
16939 /**
16940 * Interface definition for a callback to be invoked when a view is clicked.
16941 */
16942 public interface OnClickListener {
16943 /**
16944 * Called when a view has been clicked.
16945 *
16946 * @param v The view that was clicked.
16947 */
16948 void onClick(View v);
16949 }
16950
16951 /**
16952 * Interface definition for a callback to be invoked when the context menu
16953 * for this view is being built.
16954 */
16955 public interface OnCreateContextMenuListener {
16956 /**
16957 * Called when the context menu for this view is being built. It is not
16958 * safe to hold onto the menu after this method returns.
16959 *
16960 * @param menu The context menu that is being built
16961 * @param v The view for which the context menu is being built
16962 * @param menuInfo Extra information about the item for which the
16963 * context menu should be shown. This information will vary
16964 * depending on the class of v.
16965 */
16966 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo);
16967 }
16968
Joe Onorato664644d2011-01-23 17:53:23 -080016969 /**
16970 * Interface definition for a callback to be invoked when the status bar changes
Dianne Hackborn9a230e02011-10-06 11:51:27 -070016971 * visibility. This reports <strong>global</strong> changes to the system UI
Dianne Hackborncf675782012-05-10 15:07:24 -070016972 * state, not what the application is requesting.
Joe Onorato664644d2011-01-23 17:53:23 -080016973 *
Philip Milne6c8ea062012-04-03 17:38:43 -070016974 * @see View#setOnSystemUiVisibilityChangeListener(android.view.View.OnSystemUiVisibilityChangeListener)
Joe Onorato664644d2011-01-23 17:53:23 -080016975 */
16976 public interface OnSystemUiVisibilityChangeListener {
16977 /**
16978 * Called when the status bar changes visibility because of a call to
Romain Guy5c22a8c2011-05-13 11:48:45 -070016979 * {@link View#setSystemUiVisibility(int)}.
Joe Onorato664644d2011-01-23 17:53:23 -080016980 *
Dianne Hackborncf675782012-05-10 15:07:24 -070016981 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE},
16982 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, and {@link #SYSTEM_UI_FLAG_FULLSCREEN}.
16983 * This tells you the <strong>global</strong> state of these UI visibility
16984 * flags, not what your app is currently applying.
Joe Onorato664644d2011-01-23 17:53:23 -080016985 */
16986 public void onSystemUiVisibilityChange(int visibility);
16987 }
16988
Adam Powell4afd62b2011-02-18 15:02:18 -080016989 /**
16990 * Interface definition for a callback to be invoked when this view is attached
16991 * or detached from its window.
16992 */
16993 public interface OnAttachStateChangeListener {
16994 /**
16995 * Called when the view is attached to a window.
16996 * @param v The view that was attached
16997 */
16998 public void onViewAttachedToWindow(View v);
16999 /**
17000 * Called when the view is detached from a window.
17001 * @param v The view that was detached
17002 */
17003 public void onViewDetachedFromWindow(View v);
17004 }
17005
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017006 private final class UnsetPressedState implements Runnable {
17007 public void run() {
17008 setPressed(false);
17009 }
17010 }
17011
17012 /**
17013 * Base class for derived classes that want to save and restore their own
17014 * state in {@link android.view.View#onSaveInstanceState()}.
17015 */
17016 public static class BaseSavedState extends AbsSavedState {
17017 /**
17018 * Constructor used when reading from a parcel. Reads the state of the superclass.
17019 *
17020 * @param source
17021 */
17022 public BaseSavedState(Parcel source) {
17023 super(source);
17024 }
17025
17026 /**
17027 * Constructor called by derived classes when creating their SavedState objects
17028 *
17029 * @param superState The state of the superclass of this view
17030 */
17031 public BaseSavedState(Parcelable superState) {
17032 super(superState);
17033 }
17034
17035 public static final Parcelable.Creator<BaseSavedState> CREATOR =
17036 new Parcelable.Creator<BaseSavedState>() {
17037 public BaseSavedState createFromParcel(Parcel in) {
17038 return new BaseSavedState(in);
17039 }
17040
17041 public BaseSavedState[] newArray(int size) {
17042 return new BaseSavedState[size];
17043 }
17044 };
17045 }
17046
17047 /**
17048 * A set of information given to a view when it is attached to its parent
17049 * window.
17050 */
17051 static class AttachInfo {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017052 interface Callbacks {
17053 void playSoundEffect(int effectId);
17054 boolean performHapticFeedback(int effectId, boolean always);
17055 }
17056
17057 /**
17058 * InvalidateInfo is used to post invalidate(int, int, int, int) messages
17059 * to a Handler. This class contains the target (View) to invalidate and
17060 * the coordinates of the dirty rectangle.
17061 *
17062 * For performance purposes, this class also implements a pool of up to
17063 * POOL_LIMIT objects that get reused. This reduces memory allocations
17064 * whenever possible.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017065 */
Romain Guyd928d682009-03-31 17:52:16 -070017066 static class InvalidateInfo implements Poolable<InvalidateInfo> {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017067 private static final int POOL_LIMIT = 10;
Romain Guy2e9bbce2009-04-01 10:40:10 -070017068 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool(
17069 Pools.finitePool(new PoolableManager<InvalidateInfo>() {
Romain Guyd928d682009-03-31 17:52:16 -070017070 public InvalidateInfo newInstance() {
17071 return new InvalidateInfo();
17072 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017073
Romain Guyd928d682009-03-31 17:52:16 -070017074 public void onAcquired(InvalidateInfo element) {
17075 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017076
Romain Guyd928d682009-03-31 17:52:16 -070017077 public void onReleased(InvalidateInfo element) {
Romain Guy40c18f52011-09-01 17:01:18 -070017078 element.target = null;
Romain Guyd928d682009-03-31 17:52:16 -070017079 }
17080 }, POOL_LIMIT)
17081 );
17082
17083 private InvalidateInfo mNext;
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070017084 private boolean mIsPooled;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017085
17086 View target;
17087
17088 int left;
17089 int top;
17090 int right;
17091 int bottom;
17092
Romain Guyd928d682009-03-31 17:52:16 -070017093 public void setNextPoolable(InvalidateInfo element) {
17094 mNext = element;
17095 }
17096
17097 public InvalidateInfo getNextPoolable() {
17098 return mNext;
17099 }
17100
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017101 static InvalidateInfo acquire() {
Romain Guyd928d682009-03-31 17:52:16 -070017102 return sPool.acquire();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017103 }
17104
17105 void release() {
Romain Guyd928d682009-03-31 17:52:16 -070017106 sPool.release(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017107 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070017108
17109 public boolean isPooled() {
17110 return mIsPooled;
17111 }
17112
17113 public void setPooled(boolean isPooled) {
17114 mIsPooled = isPooled;
17115 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017116 }
17117
17118 final IWindowSession mSession;
17119
17120 final IWindow mWindow;
17121
17122 final IBinder mWindowToken;
17123
17124 final Callbacks mRootCallbacks;
17125
Romain Guy59a12ca2011-06-09 17:48:21 -070017126 HardwareCanvas mHardwareCanvas;
Chet Haasedaf98e92011-01-10 14:10:36 -080017127
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017128 /**
17129 * The top view of the hierarchy.
17130 */
17131 View mRootView;
Romain Guy8506ab42009-06-11 17:35:47 -070017132
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017133 IBinder mPanelParentWindowToken;
17134 Surface mSurface;
17135
Romain Guyb051e892010-09-28 19:09:36 -070017136 boolean mHardwareAccelerated;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080017137 boolean mHardwareAccelerationRequested;
Romain Guyb051e892010-09-28 19:09:36 -070017138 HardwareRenderer mHardwareRenderer;
Joe Malin32736f02011-01-19 16:14:20 -080017139
Romain Guy7e4e5612012-03-05 14:37:29 -080017140 boolean mScreenOn;
17141
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017142 /**
Romain Guy8506ab42009-06-11 17:35:47 -070017143 * Scale factor used by the compatibility mode
17144 */
17145 float mApplicationScale;
17146
17147 /**
17148 * Indicates whether the application is in compatibility mode
17149 */
17150 boolean mScalingRequired;
17151
17152 /**
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070017153 * If set, ViewAncestor doesn't use its lame animation for when the window resizes.
Dianne Hackborn63042d62011-01-26 18:56:29 -080017154 */
17155 boolean mTurnOffWindowResizeAnim;
Joe Malin32736f02011-01-19 16:14:20 -080017156
Dianne Hackborn63042d62011-01-26 18:56:29 -080017157 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017158 * Left position of this view's window
17159 */
17160 int mWindowLeft;
17161
17162 /**
17163 * Top position of this view's window
17164 */
17165 int mWindowTop;
17166
17167 /**
Adam Powell26153a32010-11-08 15:22:27 -080017168 * Indicates whether views need to use 32-bit drawing caches
Romain Guy35b38ce2009-10-07 13:38:55 -070017169 */
Adam Powell26153a32010-11-08 15:22:27 -080017170 boolean mUse32BitDrawingCache;
Romain Guy35b38ce2009-10-07 13:38:55 -070017171
17172 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017173 * For windows that are full-screen but using insets to layout inside
17174 * of the screen decorations, these are the current insets for the
17175 * content of the window.
17176 */
17177 final Rect mContentInsets = new Rect();
17178
17179 /**
17180 * For windows that are full-screen but using insets to layout inside
17181 * of the screen decorations, these are the current insets for the
17182 * actual visible parts of the window.
17183 */
17184 final Rect mVisibleInsets = new Rect();
17185
17186 /**
17187 * The internal insets given by this window. This value is
17188 * supplied by the client (through
17189 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will
17190 * be given to the window manager when changed to be used in laying
17191 * out windows behind it.
17192 */
17193 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets
17194 = new ViewTreeObserver.InternalInsetsInfo();
17195
17196 /**
17197 * All views in the window's hierarchy that serve as scroll containers,
17198 * used to determine if the window can be resized or must be panned
17199 * to adjust for a soft input area.
17200 */
17201 final ArrayList<View> mScrollContainers = new ArrayList<View>();
17202
Dianne Hackborn83fe3f52009-09-12 23:38:30 -070017203 final KeyEvent.DispatcherState mKeyDispatchState
17204 = new KeyEvent.DispatcherState();
17205
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017206 /**
17207 * Indicates whether the view's window currently has the focus.
17208 */
17209 boolean mHasWindowFocus;
17210
17211 /**
17212 * The current visibility of the window.
17213 */
17214 int mWindowVisibility;
17215
17216 /**
17217 * Indicates the time at which drawing started to occur.
17218 */
17219 long mDrawingTime;
17220
17221 /**
Romain Guy5bcdff42009-05-14 21:27:18 -070017222 * Indicates whether or not ignoring the DIRTY_MASK flags.
17223 */
17224 boolean mIgnoreDirtyState;
17225
17226 /**
Romain Guy02ccac62011-06-24 13:20:23 -070017227 * This flag tracks when the mIgnoreDirtyState flag is set during draw(),
17228 * to avoid clearing that flag prematurely.
17229 */
17230 boolean mSetIgnoreDirtyState = false;
17231
17232 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017233 * Indicates whether the view's window is currently in touch mode.
17234 */
17235 boolean mInTouchMode;
17236
17237 /**
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070017238 * Indicates that ViewAncestor should trigger a global layout change
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017239 * the next time it performs a traversal
17240 */
17241 boolean mRecomputeGlobalAttributes;
17242
17243 /**
Dianne Hackborn9a230e02011-10-06 11:51:27 -070017244 * Always report new attributes at next traversal.
17245 */
17246 boolean mForceReportNewAttributes;
17247
17248 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017249 * Set during a traveral if any views want to keep the screen on.
17250 */
17251 boolean mKeepScreenOn;
17252
17253 /**
Joe Onorato664644d2011-01-23 17:53:23 -080017254 * Bitwise-or of all of the values that views have passed to setSystemUiVisibility().
17255 */
17256 int mSystemUiVisibility;
17257
17258 /**
Dianne Hackborn139e5aa2012-05-05 20:36:38 -070017259 * Hack to force certain system UI visibility flags to be cleared.
17260 */
17261 int mDisabledSystemUiVisibility;
17262
17263 /**
Dianne Hackborncf675782012-05-10 15:07:24 -070017264 * Last global system UI visibility reported by the window manager.
17265 */
17266 int mGlobalSystemUiVisibility;
17267
17268 /**
Joe Onorato664644d2011-01-23 17:53:23 -080017269 * True if a view in this hierarchy has an OnSystemUiVisibilityChangeListener
17270 * attached.
17271 */
17272 boolean mHasSystemUiListeners;
17273
17274 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017275 * Set if the visibility of any views has changed.
17276 */
17277 boolean mViewVisibilityChanged;
17278
17279 /**
17280 * Set to true if a view has been scrolled.
17281 */
17282 boolean mViewScrollChanged;
17283
17284 /**
17285 * Global to the view hierarchy used as a temporary for dealing with
17286 * x/y points in the transparent region computations.
17287 */
17288 final int[] mTransparentLocation = new int[2];
17289
17290 /**
17291 * Global to the view hierarchy used as a temporary for dealing with
17292 * x/y points in the ViewGroup.invalidateChild implementation.
17293 */
17294 final int[] mInvalidateChildLocation = new int[2];
17295
Chet Haasec3aa3612010-06-17 08:50:37 -070017296
17297 /**
17298 * Global to the view hierarchy used as a temporary for dealing with
17299 * x/y location when view is transformed.
17300 */
17301 final float[] mTmpTransformLocation = new float[2];
17302
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017303 /**
17304 * The view tree observer used to dispatch global events like
17305 * layout, pre-draw, touch mode change, etc.
17306 */
17307 final ViewTreeObserver mTreeObserver = new ViewTreeObserver();
17308
17309 /**
17310 * A Canvas used by the view hierarchy to perform bitmap caching.
17311 */
17312 Canvas mCanvas;
17313
17314 /**
Jeff Browna175a5b2012-02-15 19:18:31 -080017315 * The view root impl.
17316 */
17317 final ViewRootImpl mViewRootImpl;
17318
17319 /**
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070017320 * A Handler supplied by a view's {@link android.view.ViewRootImpl}. This
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017321 * handler can be used to pump events in the UI events queue.
17322 */
17323 final Handler mHandler;
17324
17325 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017326 * Temporary for use in computing invalidate rectangles while
17327 * calling up the hierarchy.
17328 */
17329 final Rect mTmpInvalRect = new Rect();
svetoslavganov75986cf2009-05-14 22:28:01 -070017330
17331 /**
Chet Haasec3aa3612010-06-17 08:50:37 -070017332 * Temporary for use in computing hit areas with transformed views
17333 */
17334 final RectF mTmpTransformRect = new RectF();
17335
17336 /**
svetoslavganov75986cf2009-05-14 22:28:01 -070017337 * Temporary list for use in collecting focusable descendents of a view.
17338 */
Svetoslav Ganov42138042012-03-20 11:51:39 -070017339 final ArrayList<View> mTempArrayList = new ArrayList<View>(24);
svetoslavganov75986cf2009-05-14 22:28:01 -070017340
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017341 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070017342 * The id of the window for accessibility purposes.
17343 */
17344 int mAccessibilityWindowId = View.NO_ID;
17345
17346 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -070017347 * Whether to ingore not exposed for accessibility Views when
17348 * reporting the view tree to accessibility services.
17349 */
17350 boolean mIncludeNotImportantViews;
17351
17352 /**
17353 * The drawable for highlighting accessibility focus.
17354 */
17355 Drawable mAccessibilityFocusDrawable;
17356
17357 /**
Philip Milne10ca24a2012-04-23 15:38:27 -070017358 * Show where the margins, bounds and layout bounds are for each view.
17359 */
Dianne Hackborna53de062012-05-08 18:53:51 -070017360 boolean mDebugLayout = SystemProperties.getBoolean(DEBUG_LAYOUT_PROPERTY, false);
Philip Milne10ca24a2012-04-23 15:38:27 -070017361
17362 /**
Romain Guyab4c4f4f2012-05-06 13:11:24 -070017363 * Point used to compute visible regions.
17364 */
17365 final Point mPoint = new Point();
17366
17367 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017368 * Creates a new set of attachment information with the specified
17369 * events handler and thread.
17370 *
17371 * @param handler the events handler the view must use
17372 */
17373 AttachInfo(IWindowSession session, IWindow window,
Jeff Browna175a5b2012-02-15 19:18:31 -080017374 ViewRootImpl viewRootImpl, Handler handler, Callbacks effectPlayer) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017375 mSession = session;
17376 mWindow = window;
17377 mWindowToken = window.asBinder();
Jeff Browna175a5b2012-02-15 19:18:31 -080017378 mViewRootImpl = viewRootImpl;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017379 mHandler = handler;
17380 mRootCallbacks = effectPlayer;
17381 }
17382 }
17383
17384 /**
17385 * <p>ScrollabilityCache holds various fields used by a View when scrolling
17386 * is supported. This avoids keeping too many unused fields in most
17387 * instances of View.</p>
17388 */
Mike Cleronf116bf82009-09-27 19:14:12 -070017389 private static class ScrollabilityCache implements Runnable {
Joe Malin32736f02011-01-19 16:14:20 -080017390
Mike Cleronf116bf82009-09-27 19:14:12 -070017391 /**
17392 * Scrollbars are not visible
17393 */
17394 public static final int OFF = 0;
17395
17396 /**
17397 * Scrollbars are visible
17398 */
17399 public static final int ON = 1;
17400
17401 /**
17402 * Scrollbars are fading away
17403 */
17404 public static final int FADING = 2;
17405
17406 public boolean fadeScrollBars;
Joe Malin32736f02011-01-19 16:14:20 -080017407
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017408 public int fadingEdgeLength;
Mike Cleronf116bf82009-09-27 19:14:12 -070017409 public int scrollBarDefaultDelayBeforeFade;
17410 public int scrollBarFadeDuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017411
17412 public int scrollBarSize;
17413 public ScrollBarDrawable scrollBar;
Mike Cleronf116bf82009-09-27 19:14:12 -070017414 public float[] interpolatorValues;
17415 public View host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017416
17417 public final Paint paint;
17418 public final Matrix matrix;
17419 public Shader shader;
17420
Mike Cleronf116bf82009-09-27 19:14:12 -070017421 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2);
17422
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080017423 private static final float[] OPAQUE = { 255 };
17424 private static final float[] TRANSPARENT = { 0.0f };
Joe Malin32736f02011-01-19 16:14:20 -080017425
Mike Cleronf116bf82009-09-27 19:14:12 -070017426 /**
17427 * When fading should start. This time moves into the future every time
17428 * a new scroll happens. Measured based on SystemClock.uptimeMillis()
17429 */
17430 public long fadeStartTime;
17431
17432
17433 /**
17434 * The current state of the scrollbars: ON, OFF, or FADING
17435 */
17436 public int state = OFF;
17437
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017438 private int mLastColor;
17439
Mike Cleronf116bf82009-09-27 19:14:12 -070017440 public ScrollabilityCache(ViewConfiguration configuration, View host) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017441 fadingEdgeLength = configuration.getScaledFadingEdgeLength();
17442 scrollBarSize = configuration.getScaledScrollBarSize();
Romain Guy35b38ce2009-10-07 13:38:55 -070017443 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay();
17444 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017445
17446 paint = new Paint();
17447 matrix = new Matrix();
17448 // use use a height of 1, and then wack the matrix each time we
17449 // actually use it.
17450 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070017451
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017452 paint.setShader(shader);
17453 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT));
Mike Cleronf116bf82009-09-27 19:14:12 -070017454 this.host = host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017455 }
Romain Guy8506ab42009-06-11 17:35:47 -070017456
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017457 public void setFadeColor(int color) {
17458 if (color != 0 && color != mLastColor) {
17459 mLastColor = color;
17460 color |= 0xFF000000;
Romain Guy8506ab42009-06-11 17:35:47 -070017461
Romain Guye55e1a72009-08-27 10:42:26 -070017462 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000,
17463 color & 0x00FFFFFF, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070017464
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017465 paint.setShader(shader);
17466 // Restore the default transfer mode (src_over)
17467 paint.setXfermode(null);
17468 }
17469 }
Joe Malin32736f02011-01-19 16:14:20 -080017470
Mike Cleronf116bf82009-09-27 19:14:12 -070017471 public void run() {
Mike Cleron3ecd58c2009-09-28 11:39:02 -070017472 long now = AnimationUtils.currentAnimationTimeMillis();
Mike Cleronf116bf82009-09-27 19:14:12 -070017473 if (now >= fadeStartTime) {
17474
17475 // the animation fades the scrollbars out by changing
17476 // the opacity (alpha) from fully opaque to fully
17477 // transparent
17478 int nextFrame = (int) now;
17479 int framesCount = 0;
17480
17481 Interpolator interpolator = scrollBarInterpolator;
17482
17483 // Start opaque
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080017484 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE);
Mike Cleronf116bf82009-09-27 19:14:12 -070017485
17486 // End transparent
17487 nextFrame += scrollBarFadeDuration;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080017488 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT);
Mike Cleronf116bf82009-09-27 19:14:12 -070017489
17490 state = FADING;
17491
17492 // Kick off the fade animation
Romain Guy0fd89bf2011-01-26 15:41:30 -080017493 host.invalidate(true);
Mike Cleronf116bf82009-09-27 19:14:12 -070017494 }
17495 }
Svetoslav Ganova0156172011-06-26 17:55:44 -070017496 }
Mike Cleronf116bf82009-09-27 19:14:12 -070017497
Svetoslav Ganova0156172011-06-26 17:55:44 -070017498 /**
17499 * Resuable callback for sending
17500 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event.
17501 */
17502 private class SendViewScrolledAccessibilityEvent implements Runnable {
17503 public volatile boolean mIsPending;
17504
17505 public void run() {
17506 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_SCROLLED);
17507 mIsPending = false;
17508 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017509 }
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017510
17511 /**
17512 * <p>
17513 * This class represents a delegate that can be registered in a {@link View}
17514 * to enhance accessibility support via composition rather via inheritance.
17515 * It is specifically targeted to widget developers that extend basic View
17516 * classes i.e. classes in package android.view, that would like their
17517 * applications to be backwards compatible.
17518 * </p>
Joe Fernandeze1302ed2012-02-06 14:30:15 -080017519 * <div class="special reference">
17520 * <h3>Developer Guides</h3>
17521 * <p>For more information about making applications accessible, read the
17522 * <a href="{@docRoot}guide/topics/ui/accessibility/index.html">Accessibility</a>
17523 * developer guide.</p>
17524 * </div>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017525 * <p>
17526 * A scenario in which a developer would like to use an accessibility delegate
17527 * is overriding a method introduced in a later API version then the minimal API
17528 * version supported by the application. For example, the method
17529 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} is not available
17530 * in API version 4 when the accessibility APIs were first introduced. If a
17531 * developer would like his application to run on API version 4 devices (assuming
17532 * all other APIs used by the application are version 4 or lower) and take advantage
17533 * of this method, instead of overriding the method which would break the application's
17534 * backwards compatibility, he can override the corresponding method in this
17535 * delegate and register the delegate in the target View if the API version of
17536 * the system is high enough i.e. the API version is same or higher to the API
17537 * version that introduced
17538 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)}.
17539 * </p>
17540 * <p>
17541 * Here is an example implementation:
17542 * </p>
17543 * <code><pre><p>
17544 * if (Build.VERSION.SDK_INT >= 14) {
17545 * // If the API version is equal of higher than the version in
17546 * // which onInitializeAccessibilityNodeInfo was introduced we
17547 * // register a delegate with a customized implementation.
17548 * View view = findViewById(R.id.view_id);
17549 * view.setAccessibilityDelegate(new AccessibilityDelegate() {
17550 * public void onInitializeAccessibilityNodeInfo(View host,
17551 * AccessibilityNodeInfo info) {
17552 * // Let the default implementation populate the info.
17553 * super.onInitializeAccessibilityNodeInfo(host, info);
17554 * // Set some other information.
17555 * info.setEnabled(host.isEnabled());
17556 * }
17557 * });
17558 * }
17559 * </code></pre></p>
17560 * <p>
17561 * This delegate contains methods that correspond to the accessibility methods
17562 * in View. If a delegate has been specified the implementation in View hands
17563 * off handling to the corresponding method in this delegate. The default
17564 * implementation the delegate methods behaves exactly as the corresponding
17565 * method in View for the case of no accessibility delegate been set. Hence,
17566 * to customize the behavior of a View method, clients can override only the
17567 * corresponding delegate method without altering the behavior of the rest
17568 * accessibility related methods of the host view.
17569 * </p>
17570 */
17571 public static class AccessibilityDelegate {
17572
17573 /**
17574 * Sends an accessibility event of the given type. If accessibility is not
17575 * enabled this method has no effect.
17576 * <p>
17577 * The default implementation behaves as {@link View#sendAccessibilityEvent(int)
17578 * View#sendAccessibilityEvent(int)} for the case of no accessibility delegate
17579 * been set.
17580 * </p>
17581 *
17582 * @param host The View hosting the delegate.
17583 * @param eventType The type of the event to send.
17584 *
17585 * @see View#sendAccessibilityEvent(int) View#sendAccessibilityEvent(int)
17586 */
17587 public void sendAccessibilityEvent(View host, int eventType) {
17588 host.sendAccessibilityEventInternal(eventType);
17589 }
17590
17591 /**
alanv8eeefef2012-05-07 16:57:53 -070017592 * Performs the specified accessibility action on the view. For
17593 * possible accessibility actions look at {@link AccessibilityNodeInfo}.
17594 * <p>
17595 * The default implementation behaves as
17596 * {@link View#performAccessibilityAction(int, Bundle)
17597 * View#performAccessibilityAction(int, Bundle)} for the case of
17598 * no accessibility delegate been set.
17599 * </p>
17600 *
17601 * @param action The action to perform.
17602 * @return Whether the action was performed.
17603 *
17604 * @see View#performAccessibilityAction(int, Bundle)
17605 * View#performAccessibilityAction(int, Bundle)
17606 */
17607 public boolean performAccessibilityAction(View host, int action, Bundle args) {
17608 return host.performAccessibilityActionInternal(action, args);
17609 }
17610
17611 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017612 * Sends an accessibility event. This method behaves exactly as
17613 * {@link #sendAccessibilityEvent(View, int)} but takes as an argument an
17614 * empty {@link AccessibilityEvent} and does not perform a check whether
17615 * accessibility is enabled.
17616 * <p>
17617 * The default implementation behaves as
17618 * {@link View#sendAccessibilityEventUnchecked(AccessibilityEvent)
17619 * View#sendAccessibilityEventUnchecked(AccessibilityEvent)} for
17620 * the case of no accessibility delegate been set.
17621 * </p>
17622 *
17623 * @param host The View hosting the delegate.
17624 * @param event The event to send.
17625 *
17626 * @see View#sendAccessibilityEventUnchecked(AccessibilityEvent)
17627 * View#sendAccessibilityEventUnchecked(AccessibilityEvent)
17628 */
17629 public void sendAccessibilityEventUnchecked(View host, AccessibilityEvent event) {
17630 host.sendAccessibilityEventUncheckedInternal(event);
17631 }
17632
17633 /**
17634 * Dispatches an {@link AccessibilityEvent} to the host {@link View} first and then
17635 * to its children for adding their text content to the event.
17636 * <p>
17637 * The default implementation behaves as
17638 * {@link View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)
17639 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)} for
17640 * the case of no accessibility delegate been set.
17641 * </p>
17642 *
17643 * @param host The View hosting the delegate.
17644 * @param event The event.
17645 * @return True if the event population was completed.
17646 *
17647 * @see View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)
17648 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)
17649 */
17650 public boolean dispatchPopulateAccessibilityEvent(View host, AccessibilityEvent event) {
17651 return host.dispatchPopulateAccessibilityEventInternal(event);
17652 }
17653
17654 /**
17655 * Gives a chance to the host View to populate the accessibility event with its
17656 * text content.
17657 * <p>
17658 * The default implementation behaves as
17659 * {@link View#onPopulateAccessibilityEvent(AccessibilityEvent)
17660 * View#onPopulateAccessibilityEvent(AccessibilityEvent)} for
17661 * the case of no accessibility delegate been set.
17662 * </p>
17663 *
17664 * @param host The View hosting the delegate.
17665 * @param event The accessibility event which to populate.
17666 *
17667 * @see View#onPopulateAccessibilityEvent(AccessibilityEvent)
17668 * View#onPopulateAccessibilityEvent(AccessibilityEvent)
17669 */
17670 public void onPopulateAccessibilityEvent(View host, AccessibilityEvent event) {
17671 host.onPopulateAccessibilityEventInternal(event);
17672 }
17673
17674 /**
17675 * Initializes an {@link AccessibilityEvent} with information about the
17676 * the host View which is the event source.
17677 * <p>
17678 * The default implementation behaves as
17679 * {@link View#onInitializeAccessibilityEvent(AccessibilityEvent)
17680 * View#onInitializeAccessibilityEvent(AccessibilityEvent)} for
17681 * the case of no accessibility delegate been set.
17682 * </p>
17683 *
17684 * @param host The View hosting the delegate.
17685 * @param event The event to initialize.
17686 *
17687 * @see View#onInitializeAccessibilityEvent(AccessibilityEvent)
17688 * View#onInitializeAccessibilityEvent(AccessibilityEvent)
17689 */
17690 public void onInitializeAccessibilityEvent(View host, AccessibilityEvent event) {
17691 host.onInitializeAccessibilityEventInternal(event);
17692 }
17693
17694 /**
17695 * Initializes an {@link AccessibilityNodeInfo} with information about the host view.
17696 * <p>
17697 * The default implementation behaves as
17698 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
17699 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} for
17700 * the case of no accessibility delegate been set.
17701 * </p>
17702 *
17703 * @param host The View hosting the delegate.
17704 * @param info The instance to initialize.
17705 *
17706 * @see View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
17707 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
17708 */
17709 public void onInitializeAccessibilityNodeInfo(View host, AccessibilityNodeInfo info) {
17710 host.onInitializeAccessibilityNodeInfoInternal(info);
17711 }
17712
17713 /**
17714 * Called when a child of the host View has requested sending an
17715 * {@link AccessibilityEvent} and gives an opportunity to the parent (the host)
17716 * to augment the event.
17717 * <p>
17718 * The default implementation behaves as
17719 * {@link ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)
17720 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)} for
17721 * the case of no accessibility delegate been set.
17722 * </p>
17723 *
17724 * @param host The View hosting the delegate.
17725 * @param child The child which requests sending the event.
17726 * @param event The event to be sent.
17727 * @return True if the event should be sent
17728 *
17729 * @see ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)
17730 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)
17731 */
17732 public boolean onRequestSendAccessibilityEvent(ViewGroup host, View child,
17733 AccessibilityEvent event) {
17734 return host.onRequestSendAccessibilityEventInternal(child, event);
17735 }
Svetoslav Ganov02107852011-10-03 17:06:56 -070017736
17737 /**
17738 * Gets the provider for managing a virtual view hierarchy rooted at this View
17739 * and reported to {@link android.accessibilityservice.AccessibilityService}s
17740 * that explore the window content.
17741 * <p>
17742 * The default implementation behaves as
17743 * {@link View#getAccessibilityNodeProvider() View#getAccessibilityNodeProvider()} for
17744 * the case of no accessibility delegate been set.
17745 * </p>
17746 *
17747 * @return The provider.
17748 *
17749 * @see AccessibilityNodeProvider
17750 */
17751 public AccessibilityNodeProvider getAccessibilityNodeProvider(View host) {
17752 return null;
17753 }
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017754 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017755}