blob: fc5629eaf3fce425a50a7784747f32f6a2e1e751 [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;
Jeff Brown98365d72012-08-19 20:30:52 -070042import android.hardware.display.DisplayManager;
Jeff Brownbd6e1502012-08-28 03:27:37 -070043import android.hardware.display.DisplayManagerGlobal;
Svetoslav Ganovaa780c12012-04-19 23:01:39 -070044import android.os.Bundle;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080045import android.os.Handler;
46import android.os.IBinder;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080047import android.os.Parcel;
48import android.os.Parcelable;
49import android.os.RemoteException;
50import android.os.SystemClock;
Philip Milne10ca24a2012-04-23 15:38:27 -070051import android.os.SystemProperties;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080052import android.util.AttributeSet;
Doug Feltcb3791202011-07-07 11:57:48 -070053import android.util.FloatProperty;
54import android.util.LocaleUtil;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080055import android.util.Log;
Romain Guyd928d682009-03-31 17:52:16 -070056import android.util.Pool;
svetoslavganov75986cf2009-05-14 22:28:01 -070057import android.util.Poolable;
Romain Guyd928d682009-03-31 17:52:16 -070058import android.util.PoolableManager;
svetoslavganov75986cf2009-05-14 22:28:01 -070059import android.util.Pools;
Doug Feltcb3791202011-07-07 11:57:48 -070060import android.util.Property;
svetoslavganov75986cf2009-05-14 22:28:01 -070061import android.util.SparseArray;
Jeff Brown33bbfd22011-02-24 20:55:35 -080062import android.util.TypedValue;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080063import android.view.ContextMenu.ContextMenuInfo;
Svetoslav Ganov6d17a932012-04-27 19:30:38 -070064import android.view.AccessibilityIterators.TextSegmentIterator;
65import android.view.AccessibilityIterators.CharacterTextSegmentIterator;
66import android.view.AccessibilityIterators.WordTextSegmentIterator;
67import android.view.AccessibilityIterators.ParagraphTextSegmentIterator;
svetoslavganov75986cf2009-05-14 22:28:01 -070068import android.view.accessibility.AccessibilityEvent;
69import android.view.accessibility.AccessibilityEventSource;
70import android.view.accessibility.AccessibilityManager;
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070071import android.view.accessibility.AccessibilityNodeInfo;
Svetoslav Ganov02107852011-10-03 17:06:56 -070072import android.view.accessibility.AccessibilityNodeProvider;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080073import android.view.animation.Animation;
Mike Cleron3ecd58c2009-09-28 11:39:02 -070074import android.view.animation.AnimationUtils;
Chet Haase64a48c12012-02-13 16:33:29 -080075import android.view.animation.Transformation;
svetoslavganov75986cf2009-05-14 22:28:01 -070076import android.view.inputmethod.EditorInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080077import android.view.inputmethod.InputConnection;
78import android.view.inputmethod.InputMethodManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080079import android.widget.ScrollBarDrawable;
80
Romain Guy1ef3fdb2011-09-09 15:30:30 -070081import static android.os.Build.VERSION_CODES.*;
Philip Milne6c8ea062012-04-03 17:38:43 -070082import static java.lang.Math.max;
Romain Guy1ef3fdb2011-09-09 15:30:30 -070083
Doug Feltcb3791202011-07-07 11:57:48 -070084import com.android.internal.R;
85import com.android.internal.util.Predicate;
86import com.android.internal.view.menu.MenuBuilder;
87
Christopher Tatea0374192010-10-05 13:06:41 -070088import java.lang.ref.WeakReference;
svetoslavganov75986cf2009-05-14 22:28:01 -070089import java.lang.reflect.InvocationTargetException;
90import java.lang.reflect.Method;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080091import java.util.ArrayList;
92import java.util.Arrays;
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070093import java.util.Locale;
Adam Powell4afd62b2011-02-18 15:02:18 -080094import java.util.concurrent.CopyOnWriteArrayList;
Adam Powella9108a22012-07-18 11:18:09 -070095import java.util.concurrent.atomic.AtomicInteger;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080096
97/**
98 * <p>
99 * This class represents the basic building block for user interface components. A View
100 * occupies a rectangular area on the screen and is responsible for drawing and
101 * event handling. View is the base class for <em>widgets</em>, which are
Romain Guy8506ab42009-06-11 17:35:47 -0700102 * used to create interactive UI components (buttons, text fields, etc.). The
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800103 * {@link android.view.ViewGroup} subclass is the base class for <em>layouts</em>, which
104 * are invisible containers that hold other Views (or other ViewGroups) and define
105 * their layout properties.
106 * </p>
107 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -0700108 * <div class="special reference">
109 * <h3>Developer Guides</h3>
110 * <p>For information about using this class to develop your application's user interface,
111 * 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 -0800112 * </div>
Romain Guy8506ab42009-06-11 17:35:47 -0700113 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800114 * <a name="Using"></a>
115 * <h3>Using Views</h3>
116 * <p>
117 * All of the views in a window are arranged in a single tree. You can add views
118 * either from code or by specifying a tree of views in one or more XML layout
119 * files. There are many specialized subclasses of views that act as controls or
120 * are capable of displaying text, images, or other content.
121 * </p>
122 * <p>
123 * Once you have created a tree of views, there are typically a few types of
124 * common operations you may wish to perform:
125 * <ul>
126 * <li><strong>Set properties:</strong> for example setting the text of a
127 * {@link android.widget.TextView}. The available properties and the methods
128 * that set them will vary among the different subclasses of views. Note that
129 * properties that are known at build time can be set in the XML layout
130 * files.</li>
131 * <li><strong>Set focus:</strong> The framework will handled moving focus in
132 * response to user input. To force focus to a specific view, call
133 * {@link #requestFocus}.</li>
134 * <li><strong>Set up listeners:</strong> Views allow clients to set listeners
135 * that will be notified when something interesting happens to the view. For
136 * example, all views will let you set a listener to be notified when the view
137 * gains or loses focus. You can register such a listener using
Romain Guy5c22a8c2011-05-13 11:48:45 -0700138 * {@link #setOnFocusChangeListener(android.view.View.OnFocusChangeListener)}.
Philip Milne6c8ea062012-04-03 17:38:43 -0700139 * Other view subclasses offer more specialized listeners. For example, a Button
Romain Guy5c22a8c2011-05-13 11:48:45 -0700140 * exposes a listener to notify clients when the button is clicked.</li>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800141 * <li><strong>Set visibility:</strong> You can hide or show views using
Romain Guy5c22a8c2011-05-13 11:48:45 -0700142 * {@link #setVisibility(int)}.</li>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800143 * </ul>
144 * </p>
145 * <p><em>
146 * Note: The Android framework is responsible for measuring, laying out and
147 * drawing views. You should not call methods that perform these actions on
148 * views yourself unless you are actually implementing a
149 * {@link android.view.ViewGroup}.
150 * </em></p>
151 *
152 * <a name="Lifecycle"></a>
153 * <h3>Implementing a Custom View</h3>
154 *
155 * <p>
156 * To implement a custom view, you will usually begin by providing overrides for
157 * some of the standard methods that the framework calls on all views. You do
158 * not need to override all of these methods. In fact, you can start by just
159 * overriding {@link #onDraw(android.graphics.Canvas)}.
160 * <table border="2" width="85%" align="center" cellpadding="5">
161 * <thead>
162 * <tr><th>Category</th> <th>Methods</th> <th>Description</th></tr>
163 * </thead>
164 *
165 * <tbody>
166 * <tr>
167 * <td rowspan="2">Creation</td>
168 * <td>Constructors</td>
169 * <td>There is a form of the constructor that are called when the view
170 * is created from code and a form that is called when the view is
171 * inflated from a layout file. The second form should parse and apply
172 * any attributes defined in the layout file.
173 * </td>
174 * </tr>
175 * <tr>
176 * <td><code>{@link #onFinishInflate()}</code></td>
177 * <td>Called after a view and all of its children has been inflated
178 * from XML.</td>
179 * </tr>
180 *
181 * <tr>
182 * <td rowspan="3">Layout</td>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700183 * <td><code>{@link #onMeasure(int, int)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800184 * <td>Called to determine the size requirements for this view and all
185 * of its children.
186 * </td>
187 * </tr>
188 * <tr>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700189 * <td><code>{@link #onLayout(boolean, int, int, int, int)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800190 * <td>Called when this view should assign a size and position to all
191 * of its children.
192 * </td>
193 * </tr>
194 * <tr>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700195 * <td><code>{@link #onSizeChanged(int, int, int, int)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800196 * <td>Called when the size of this view has changed.
197 * </td>
198 * </tr>
199 *
200 * <tr>
201 * <td>Drawing</td>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700202 * <td><code>{@link #onDraw(android.graphics.Canvas)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800203 * <td>Called when the view should render its content.
204 * </td>
205 * </tr>
206 *
207 * <tr>
208 * <td rowspan="4">Event processing</td>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700209 * <td><code>{@link #onKeyDown(int, KeyEvent)}</code></td>
Jean Chalard405bc512012-05-29 19:12:34 +0900210 * <td>Called when a new hardware key event occurs.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800211 * </td>
212 * </tr>
213 * <tr>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700214 * <td><code>{@link #onKeyUp(int, KeyEvent)}</code></td>
Jean Chalard405bc512012-05-29 19:12:34 +0900215 * <td>Called when a hardware key up event occurs.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800216 * </td>
217 * </tr>
218 * <tr>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700219 * <td><code>{@link #onTrackballEvent(MotionEvent)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800220 * <td>Called when a trackball motion event occurs.
221 * </td>
222 * </tr>
223 * <tr>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700224 * <td><code>{@link #onTouchEvent(MotionEvent)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800225 * <td>Called when a touch screen motion event occurs.
226 * </td>
227 * </tr>
228 *
229 * <tr>
230 * <td rowspan="2">Focus</td>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700231 * <td><code>{@link #onFocusChanged(boolean, int, android.graphics.Rect)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800232 * <td>Called when the view gains or loses focus.
233 * </td>
234 * </tr>
235 *
236 * <tr>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700237 * <td><code>{@link #onWindowFocusChanged(boolean)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800238 * <td>Called when the window containing the view gains or loses focus.
239 * </td>
240 * </tr>
241 *
242 * <tr>
243 * <td rowspan="3">Attaching</td>
244 * <td><code>{@link #onAttachedToWindow()}</code></td>
245 * <td>Called when the view is attached to a window.
246 * </td>
247 * </tr>
248 *
249 * <tr>
250 * <td><code>{@link #onDetachedFromWindow}</code></td>
251 * <td>Called when the view is detached from its window.
252 * </td>
253 * </tr>
254 *
255 * <tr>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700256 * <td><code>{@link #onWindowVisibilityChanged(int)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800257 * <td>Called when the visibility of the window containing the view
258 * has changed.
259 * </td>
260 * </tr>
261 * </tbody>
262 *
263 * </table>
264 * </p>
265 *
266 * <a name="IDs"></a>
267 * <h3>IDs</h3>
268 * Views may have an integer id associated with them. These ids are typically
269 * assigned in the layout XML files, and are used to find specific views within
270 * the view tree. A common pattern is to:
271 * <ul>
272 * <li>Define a Button in the layout file and assign it a unique ID.
273 * <pre>
Gilles Debunne0243caf2010-08-24 23:06:35 -0700274 * &lt;Button
275 * android:id="@+id/my_button"
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800276 * android:layout_width="wrap_content"
277 * android:layout_height="wrap_content"
278 * android:text="@string/my_button_text"/&gt;
279 * </pre></li>
280 * <li>From the onCreate method of an Activity, find the Button
281 * <pre class="prettyprint">
282 * Button myButton = (Button) findViewById(R.id.my_button);
283 * </pre></li>
284 * </ul>
285 * <p>
286 * View IDs need not be unique throughout the tree, but it is good practice to
287 * ensure that they are at least unique within the part of the tree you are
288 * searching.
289 * </p>
290 *
291 * <a name="Position"></a>
292 * <h3>Position</h3>
293 * <p>
294 * The geometry of a view is that of a rectangle. A view has a location,
295 * expressed as a pair of <em>left</em> and <em>top</em> coordinates, and
296 * two dimensions, expressed as a width and a height. The unit for location
297 * and dimensions is the pixel.
298 * </p>
299 *
300 * <p>
301 * It is possible to retrieve the location of a view by invoking the methods
302 * {@link #getLeft()} and {@link #getTop()}. The former returns the left, or X,
303 * coordinate of the rectangle representing the view. The latter returns the
304 * top, or Y, coordinate of the rectangle representing the view. These methods
305 * both return the location of the view relative to its parent. For instance,
306 * when getLeft() returns 20, that means the view is located 20 pixels to the
307 * right of the left edge of its direct parent.
308 * </p>
309 *
310 * <p>
311 * In addition, several convenience methods are offered to avoid unnecessary
312 * computations, namely {@link #getRight()} and {@link #getBottom()}.
313 * These methods return the coordinates of the right and bottom edges of the
314 * rectangle representing the view. For instance, calling {@link #getRight()}
315 * is similar to the following computation: <code>getLeft() + getWidth()</code>
316 * (see <a href="#SizePaddingMargins">Size</a> for more information about the width.)
317 * </p>
318 *
319 * <a name="SizePaddingMargins"></a>
320 * <h3>Size, padding and margins</h3>
321 * <p>
322 * The size of a view is expressed with a width and a height. A view actually
323 * possess two pairs of width and height values.
324 * </p>
325 *
326 * <p>
327 * The first pair is known as <em>measured width</em> and
328 * <em>measured height</em>. These dimensions define how big a view wants to be
329 * within its parent (see <a href="#Layout">Layout</a> for more details.) The
330 * measured dimensions can be obtained by calling {@link #getMeasuredWidth()}
331 * and {@link #getMeasuredHeight()}.
332 * </p>
333 *
334 * <p>
335 * The second pair is simply known as <em>width</em> and <em>height</em>, or
336 * sometimes <em>drawing width</em> and <em>drawing height</em>. These
337 * dimensions define the actual size of the view on screen, at drawing time and
338 * after layout. These values may, but do not have to, be different from the
339 * measured width and height. The width and height can be obtained by calling
340 * {@link #getWidth()} and {@link #getHeight()}.
341 * </p>
342 *
343 * <p>
344 * To measure its dimensions, a view takes into account its padding. The padding
345 * is expressed in pixels for the left, top, right and bottom parts of the view.
346 * Padding can be used to offset the content of the view by a specific amount of
347 * pixels. For instance, a left padding of 2 will push the view's content by
348 * 2 pixels to the right of the left edge. Padding can be set using the
Fabrice Di Meglio30a21e12012-03-12 13:12:19 -0700349 * {@link #setPadding(int, int, int, int)} or {@link #setPaddingRelative(int, int, int, int)}
350 * method and queried by calling {@link #getPaddingLeft()}, {@link #getPaddingTop()},
351 * {@link #getPaddingRight()}, {@link #getPaddingBottom()}, {@link #getPaddingStart()},
352 * {@link #getPaddingEnd()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800353 * </p>
354 *
355 * <p>
356 * Even though a view can define a padding, it does not provide any support for
357 * margins. However, view groups provide such a support. Refer to
358 * {@link android.view.ViewGroup} and
359 * {@link android.view.ViewGroup.MarginLayoutParams} for further information.
360 * </p>
361 *
362 * <a name="Layout"></a>
363 * <h3>Layout</h3>
364 * <p>
365 * Layout is a two pass process: a measure pass and a layout pass. The measuring
366 * pass is implemented in {@link #measure(int, int)} and is a top-down traversal
367 * of the view tree. Each view pushes dimension specifications down the tree
368 * during the recursion. At the end of the measure pass, every view has stored
369 * its measurements. The second pass happens in
370 * {@link #layout(int,int,int,int)} and is also top-down. During
371 * this pass each parent is responsible for positioning all of its children
372 * using the sizes computed in the measure pass.
373 * </p>
374 *
375 * <p>
376 * When a view's measure() method returns, its {@link #getMeasuredWidth()} and
377 * {@link #getMeasuredHeight()} values must be set, along with those for all of
378 * that view's descendants. A view's measured width and measured height values
379 * must respect the constraints imposed by the view's parents. This guarantees
380 * that at the end of the measure pass, all parents accept all of their
381 * children's measurements. A parent view may call measure() more than once on
382 * its children. For example, the parent may measure each child once with
383 * unspecified dimensions to find out how big they want to be, then call
384 * measure() on them again with actual numbers if the sum of all the children's
385 * unconstrained sizes is too big or too small.
386 * </p>
387 *
388 * <p>
389 * The measure pass uses two classes to communicate dimensions. The
390 * {@link MeasureSpec} class is used by views to tell their parents how they
391 * want to be measured and positioned. The base LayoutParams class just
392 * describes how big the view wants to be for both width and height. For each
393 * dimension, it can specify one of:
394 * <ul>
395 * <li> an exact number
Romain Guy980a9382010-01-08 15:06:28 -0800396 * <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 -0800397 * (minus padding)
398 * <li> WRAP_CONTENT, which means that the view wants to be just big enough to
399 * enclose its content (plus padding).
400 * </ul>
401 * There are subclasses of LayoutParams for different subclasses of ViewGroup.
402 * For example, AbsoluteLayout has its own subclass of LayoutParams which adds
403 * an X and Y value.
404 * </p>
405 *
406 * <p>
407 * MeasureSpecs are used to push requirements down the tree from parent to
408 * child. A MeasureSpec can be in one of three modes:
409 * <ul>
410 * <li>UNSPECIFIED: This is used by a parent to determine the desired dimension
411 * of a child view. For example, a LinearLayout may call measure() on its child
412 * with the height set to UNSPECIFIED and a width of EXACTLY 240 to find out how
413 * tall the child view wants to be given a width of 240 pixels.
414 * <li>EXACTLY: This is used by the parent to impose an exact size on the
415 * child. The child must use this size, and guarantee that all of its
416 * descendants will fit within this size.
417 * <li>AT_MOST: This is used by the parent to impose a maximum size on the
418 * child. The child must gurantee that it and all of its descendants will fit
419 * within this size.
420 * </ul>
421 * </p>
422 *
423 * <p>
424 * To intiate a layout, call {@link #requestLayout}. This method is typically
425 * called by a view on itself when it believes that is can no longer fit within
426 * its current bounds.
427 * </p>
428 *
429 * <a name="Drawing"></a>
430 * <h3>Drawing</h3>
431 * <p>
432 * Drawing is handled by walking the tree and rendering each view that
Joe Fernandez558459f2011-10-13 16:47:36 -0700433 * intersects the invalid region. Because the tree is traversed in-order,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800434 * this means that parents will draw before (i.e., behind) their children, with
435 * siblings drawn in the order they appear in the tree.
436 * If you set a background drawable for a View, then the View will draw it for you
437 * before calling back to its <code>onDraw()</code> method.
438 * </p>
439 *
440 * <p>
Romain Guy8506ab42009-06-11 17:35:47 -0700441 * 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 -0800442 * </p>
443 *
444 * <p>
445 * To force a view to draw, call {@link #invalidate()}.
446 * </p>
447 *
448 * <a name="EventHandlingThreading"></a>
449 * <h3>Event Handling and Threading</h3>
450 * <p>
451 * The basic cycle of a view is as follows:
452 * <ol>
453 * <li>An event comes in and is dispatched to the appropriate view. The view
454 * handles the event and notifies any listeners.</li>
455 * <li>If in the course of processing the event, the view's bounds may need
456 * to be changed, the view will call {@link #requestLayout()}.</li>
457 * <li>Similarly, if in the course of processing the event the view's appearance
458 * may need to be changed, the view will call {@link #invalidate()}.</li>
459 * <li>If either {@link #requestLayout()} or {@link #invalidate()} were called,
460 * the framework will take care of measuring, laying out, and drawing the tree
461 * as appropriate.</li>
462 * </ol>
463 * </p>
464 *
465 * <p><em>Note: The entire view tree is single threaded. You must always be on
466 * the UI thread when calling any method on any view.</em>
467 * If you are doing work on other threads and want to update the state of a view
468 * from that thread, you should use a {@link Handler}.
469 * </p>
470 *
471 * <a name="FocusHandling"></a>
472 * <h3>Focus Handling</h3>
473 * <p>
474 * The framework will handle routine focus movement in response to user input.
475 * This includes changing the focus as views are removed or hidden, or as new
476 * views become available. Views indicate their willingness to take focus
477 * through the {@link #isFocusable} method. To change whether a view can take
478 * focus, call {@link #setFocusable(boolean)}. When in touch mode (see notes below)
479 * views indicate whether they still would like focus via {@link #isFocusableInTouchMode}
480 * and can change this via {@link #setFocusableInTouchMode(boolean)}.
481 * </p>
482 * <p>
483 * Focus movement is based on an algorithm which finds the nearest neighbor in a
484 * given direction. In rare cases, the default algorithm may not match the
485 * intended behavior of the developer. In these situations, you can provide
486 * explicit overrides by using these XML attributes in the layout file:
487 * <pre>
488 * nextFocusDown
489 * nextFocusLeft
490 * nextFocusRight
491 * nextFocusUp
492 * </pre>
493 * </p>
494 *
495 *
496 * <p>
497 * To get a particular view to take focus, call {@link #requestFocus()}.
498 * </p>
499 *
500 * <a name="TouchMode"></a>
501 * <h3>Touch Mode</h3>
502 * <p>
503 * When a user is navigating a user interface via directional keys such as a D-pad, it is
504 * necessary to give focus to actionable items such as buttons so the user can see
505 * what will take input. If the device has touch capabilities, however, and the user
506 * begins interacting with the interface by touching it, it is no longer necessary to
507 * always highlight, or give focus to, a particular view. This motivates a mode
508 * for interaction named 'touch mode'.
509 * </p>
510 * <p>
511 * For a touch capable device, once the user touches the screen, the device
512 * will enter touch mode. From this point onward, only views for which
513 * {@link #isFocusableInTouchMode} is true will be focusable, such as text editing widgets.
514 * Other views that are touchable, like buttons, will not take focus when touched; they will
515 * only fire the on click listeners.
516 * </p>
517 * <p>
518 * Any time a user hits a directional key, such as a D-pad direction, the view device will
519 * exit touch mode, and find a view to take focus, so that the user may resume interacting
520 * with the user interface without touching the screen again.
521 * </p>
522 * <p>
523 * The touch mode state is maintained across {@link android.app.Activity}s. Call
524 * {@link #isInTouchMode} to see whether the device is currently in touch mode.
525 * </p>
526 *
527 * <a name="Scrolling"></a>
528 * <h3>Scrolling</h3>
529 * <p>
530 * The framework provides basic support for views that wish to internally
531 * scroll their content. This includes keeping track of the X and Y scroll
532 * offset as well as mechanisms for drawing scrollbars. See
Joe Malin32736f02011-01-19 16:14:20 -0800533 * {@link #scrollBy(int, int)}, {@link #scrollTo(int, int)}, and
Mike Cleronf116bf82009-09-27 19:14:12 -0700534 * {@link #awakenScrollBars()} for more details.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800535 * </p>
536 *
537 * <a name="Tags"></a>
538 * <h3>Tags</h3>
539 * <p>
540 * Unlike IDs, tags are not used to identify views. Tags are essentially an
541 * extra piece of information that can be associated with a view. They are most
542 * often used as a convenience to store data related to views in the views
543 * themselves rather than by putting them in a separate structure.
544 * </p>
545 *
Chet Haasecb150fe2012-05-03 15:15:05 -0700546 * <a name="Properties"></a>
547 * <h3>Properties</h3>
548 * <p>
549 * The View class exposes an {@link #ALPHA} property, as well as several transform-related
550 * properties, such as {@link #TRANSLATION_X} and {@link #TRANSLATION_Y}. These properties are
551 * available both in the {@link Property} form as well as in similarly-named setter/getter
552 * methods (such as {@link #setAlpha(float)} for {@link #ALPHA}). These properties can
553 * be used to set persistent state associated with these rendering-related properties on the view.
554 * The properties and methods can also be used in conjunction with
555 * {@link android.animation.Animator Animator}-based animations, described more in the
556 * <a href="#Animation">Animation</a> section.
557 * </p>
558 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800559 * <a name="Animation"></a>
560 * <h3>Animation</h3>
561 * <p>
Chet Haasecb150fe2012-05-03 15:15:05 -0700562 * Starting with Android 3.0, the preferred way of animating views is to use the
563 * {@link android.animation} package APIs. These {@link android.animation.Animator Animator}-based
564 * classes change actual properties of the View object, such as {@link #setAlpha(float) alpha} and
565 * {@link #setTranslationX(float) translationX}. This behavior is contrasted to that of the pre-3.0
566 * {@link android.view.animation.Animation Animation}-based classes, which instead animate only
567 * how the view is drawn on the display. In particular, the {@link ViewPropertyAnimator} class
568 * makes animating these View properties particularly easy and efficient.
569 * </p>
570 * <p>
571 * 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 -0800572 * You can attach an {@link Animation} object to a view using
573 * {@link #setAnimation(Animation)} or
574 * {@link #startAnimation(Animation)}. The animation can alter the scale,
575 * rotation, translation and alpha of a view over time. If the animation is
576 * attached to a view that has children, the animation will affect the entire
577 * subtree rooted by that node. When an animation is started, the framework will
578 * take care of redrawing the appropriate views until the animation completes.
579 * </p>
580 *
Jeff Brown85a31762010-09-01 17:01:00 -0700581 * <a name="Security"></a>
582 * <h3>Security</h3>
583 * <p>
584 * Sometimes it is essential that an application be able to verify that an action
585 * is being performed with the full knowledge and consent of the user, such as
586 * granting a permission request, making a purchase or clicking on an advertisement.
587 * Unfortunately, a malicious application could try to spoof the user into
588 * performing these actions, unaware, by concealing the intended purpose of the view.
589 * As a remedy, the framework offers a touch filtering mechanism that can be used to
590 * improve the security of views that provide access to sensitive functionality.
591 * </p><p>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700592 * To enable touch filtering, call {@link #setFilterTouchesWhenObscured(boolean)} or set the
Jeff Brown49ed71d2010-12-06 17:13:33 -0800593 * android:filterTouchesWhenObscured layout attribute to true. When enabled, the framework
Jeff Brown85a31762010-09-01 17:01:00 -0700594 * will discard touches that are received whenever the view's window is obscured by
595 * another visible window. As a result, the view will not receive touches whenever a
596 * toast, dialog or other window appears above the view's window.
597 * </p><p>
598 * For more fine-grained control over security, consider overriding the
Romain Guy5c22a8c2011-05-13 11:48:45 -0700599 * {@link #onFilterTouchEventForSecurity(MotionEvent)} method to implement your own
600 * security policy. See also {@link MotionEvent#FLAG_WINDOW_IS_OBSCURED}.
Jeff Brown85a31762010-09-01 17:01:00 -0700601 * </p>
602 *
Romain Guy171c5922011-01-06 10:04:23 -0800603 * @attr ref android.R.styleable#View_alpha
Romain Guyd6a463a2009-05-21 23:10:10 -0700604 * @attr ref android.R.styleable#View_background
605 * @attr ref android.R.styleable#View_clickable
606 * @attr ref android.R.styleable#View_contentDescription
607 * @attr ref android.R.styleable#View_drawingCacheQuality
608 * @attr ref android.R.styleable#View_duplicateParentState
609 * @attr ref android.R.styleable#View_id
Romain Guy1ef3fdb2011-09-09 15:30:30 -0700610 * @attr ref android.R.styleable#View_requiresFadingEdge
Philip Milne6c8ea062012-04-03 17:38:43 -0700611 * @attr ref android.R.styleable#View_fadeScrollbars
Romain Guyd6a463a2009-05-21 23:10:10 -0700612 * @attr ref android.R.styleable#View_fadingEdgeLength
Jeff Brown85a31762010-09-01 17:01:00 -0700613 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800614 * @attr ref android.R.styleable#View_fitsSystemWindows
Romain Guyd6a463a2009-05-21 23:10:10 -0700615 * @attr ref android.R.styleable#View_isScrollContainer
616 * @attr ref android.R.styleable#View_focusable
617 * @attr ref android.R.styleable#View_focusableInTouchMode
618 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
619 * @attr ref android.R.styleable#View_keepScreenOn
Romain Guy171c5922011-01-06 10:04:23 -0800620 * @attr ref android.R.styleable#View_layerType
Romain Guyd6a463a2009-05-21 23:10:10 -0700621 * @attr ref android.R.styleable#View_longClickable
622 * @attr ref android.R.styleable#View_minHeight
623 * @attr ref android.R.styleable#View_minWidth
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800624 * @attr ref android.R.styleable#View_nextFocusDown
625 * @attr ref android.R.styleable#View_nextFocusLeft
626 * @attr ref android.R.styleable#View_nextFocusRight
627 * @attr ref android.R.styleable#View_nextFocusUp
Romain Guyd6a463a2009-05-21 23:10:10 -0700628 * @attr ref android.R.styleable#View_onClick
629 * @attr ref android.R.styleable#View_padding
630 * @attr ref android.R.styleable#View_paddingBottom
631 * @attr ref android.R.styleable#View_paddingLeft
632 * @attr ref android.R.styleable#View_paddingRight
633 * @attr ref android.R.styleable#View_paddingTop
Fabrice Di Meglio101d5aa2012-02-16 18:36:06 -0800634 * @attr ref android.R.styleable#View_paddingStart
635 * @attr ref android.R.styleable#View_paddingEnd
Romain Guyd6a463a2009-05-21 23:10:10 -0700636 * @attr ref android.R.styleable#View_saveEnabled
Chet Haase73066682010-11-29 15:55:32 -0800637 * @attr ref android.R.styleable#View_rotation
638 * @attr ref android.R.styleable#View_rotationX
639 * @attr ref android.R.styleable#View_rotationY
640 * @attr ref android.R.styleable#View_scaleX
641 * @attr ref android.R.styleable#View_scaleY
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800642 * @attr ref android.R.styleable#View_scrollX
643 * @attr ref android.R.styleable#View_scrollY
Romain Guyd6a463a2009-05-21 23:10:10 -0700644 * @attr ref android.R.styleable#View_scrollbarSize
645 * @attr ref android.R.styleable#View_scrollbarStyle
646 * @attr ref android.R.styleable#View_scrollbars
Mike Cleronf116bf82009-09-27 19:14:12 -0700647 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade
648 * @attr ref android.R.styleable#View_scrollbarFadeDuration
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800649 * @attr ref android.R.styleable#View_scrollbarTrackHorizontal
650 * @attr ref android.R.styleable#View_scrollbarThumbHorizontal
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800651 * @attr ref android.R.styleable#View_scrollbarThumbVertical
652 * @attr ref android.R.styleable#View_scrollbarTrackVertical
653 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawHorizontalTrack
654 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawVerticalTrack
Romain Guyd6a463a2009-05-21 23:10:10 -0700655 * @attr ref android.R.styleable#View_soundEffectsEnabled
656 * @attr ref android.R.styleable#View_tag
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -0700657 * @attr ref android.R.styleable#View_textAlignment
Chet Haase73066682010-11-29 15:55:32 -0800658 * @attr ref android.R.styleable#View_transformPivotX
659 * @attr ref android.R.styleable#View_transformPivotY
660 * @attr ref android.R.styleable#View_translationX
661 * @attr ref android.R.styleable#View_translationY
Romain Guyd6a463a2009-05-21 23:10:10 -0700662 * @attr ref android.R.styleable#View_visibility
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800663 *
664 * @see android.view.ViewGroup
665 */
Fabrice Di Megliob03b4342012-06-04 12:55:30 -0700666public class View implements Drawable.Callback, KeyEvent.Callback,
Adam Powell8fc54f92011-09-07 16:40:45 -0700667 AccessibilityEventSource {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800668 private static final boolean DBG = false;
669
670 /**
671 * The logging tag used by this class with android.util.Log.
672 */
673 protected static final String VIEW_LOG_TAG = "View";
674
675 /**
Guang Zhu0d607fb2012-05-11 19:34:56 -0700676 * When set to true, apps will draw debugging information about their layouts.
Romain Guy4b8c4f82012-04-27 15:48:35 -0700677 *
678 * @hide
679 */
680 public static final String DEBUG_LAYOUT_PROPERTY = "debug.layout";
681
682 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800683 * Used to mark a View that has no ID.
684 */
685 public static final int NO_ID = -1;
686
687 /**
688 * This view does not want keystrokes. Use with TAKES_FOCUS_MASK when
689 * calling setFlags.
690 */
691 private static final int NOT_FOCUSABLE = 0x00000000;
692
693 /**
694 * This view wants keystrokes. Use with TAKES_FOCUS_MASK when calling
695 * setFlags.
696 */
697 private static final int FOCUSABLE = 0x00000001;
698
699 /**
700 * Mask for use with setFlags indicating bits used for focus.
701 */
702 private static final int FOCUSABLE_MASK = 0x00000001;
703
704 /**
705 * This view will adjust its padding to fit sytem windows (e.g. status bar)
706 */
707 private static final int FITS_SYSTEM_WINDOWS = 0x00000002;
708
709 /**
Scott Main812634c22011-07-27 13:22:35 -0700710 * This view is visible.
711 * 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 VISIBLE = 0x00000000;
715
716 /**
717 * This view is invisible, but it still takes up space for layout purposes.
Scott Main812634c22011-07-27 13:22:35 -0700718 * 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 INVISIBLE = 0x00000004;
722
723 /**
724 * This view is invisible, and it doesn't take any space for layout
Scott Main812634c22011-07-27 13:22:35 -0700725 * purposes. Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code
726 * android:visibility}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800727 */
728 public static final int GONE = 0x00000008;
729
730 /**
731 * Mask for use with setFlags indicating bits used for visibility.
732 * {@hide}
733 */
734 static final int VISIBILITY_MASK = 0x0000000C;
735
736 private static final int[] VISIBILITY_FLAGS = {VISIBLE, INVISIBLE, GONE};
737
738 /**
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -0700739 * This view is enabled. 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 ENABLED = 0x00000000;
744
745 /**
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -0700746 * This view is disabled. Interpretation varies by subclass.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800747 * Use with ENABLED_MASK when calling setFlags.
748 * {@hide}
749 */
750 static final int DISABLED = 0x00000020;
751
752 /**
753 * Mask for use with setFlags indicating bits used for indicating whether
754 * this view is enabled
755 * {@hide}
756 */
757 static final int ENABLED_MASK = 0x00000020;
758
759 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -0700760 * This view won't draw. {@link #onDraw(android.graphics.Canvas)} won't be
761 * called and further optimizations will be performed. It is okay to have
762 * this flag set and a background. Use with DRAW_MASK when calling setFlags.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800763 * {@hide}
764 */
765 static final int WILL_NOT_DRAW = 0x00000080;
766
767 /**
768 * Mask for use with setFlags indicating bits used for indicating whether
769 * this view is will draw
770 * {@hide}
771 */
772 static final int DRAW_MASK = 0x00000080;
773
774 /**
775 * <p>This view doesn't show scrollbars.</p>
776 * {@hide}
777 */
778 static final int SCROLLBARS_NONE = 0x00000000;
779
780 /**
781 * <p>This view shows horizontal scrollbars.</p>
782 * {@hide}
783 */
784 static final int SCROLLBARS_HORIZONTAL = 0x00000100;
785
786 /**
787 * <p>This view shows vertical scrollbars.</p>
788 * {@hide}
789 */
790 static final int SCROLLBARS_VERTICAL = 0x00000200;
791
792 /**
793 * <p>Mask for use with setFlags indicating bits used for indicating which
794 * scrollbars are enabled.</p>
795 * {@hide}
796 */
797 static final int SCROLLBARS_MASK = 0x00000300;
798
Jeff Brown85a31762010-09-01 17:01:00 -0700799 /**
800 * Indicates that the view should filter touches when its window is obscured.
801 * Refer to the class comments for more information about this security feature.
802 * {@hide}
803 */
804 static final int FILTER_TOUCHES_WHEN_OBSCURED = 0x00000400;
805
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -0700806 /**
807 * Set for framework elements that use FITS_SYSTEM_WINDOWS, to indicate
808 * that they are optional and should be skipped if the window has
809 * requested system UI flags that ignore those insets for layout.
810 */
811 static final int OPTIONAL_FITS_SYSTEM_WINDOWS = 0x00000800;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800812
813 /**
814 * <p>This view doesn't show fading edges.</p>
815 * {@hide}
816 */
817 static final int FADING_EDGE_NONE = 0x00000000;
818
819 /**
820 * <p>This view shows horizontal fading edges.</p>
821 * {@hide}
822 */
823 static final int FADING_EDGE_HORIZONTAL = 0x00001000;
824
825 /**
826 * <p>This view shows vertical fading edges.</p>
827 * {@hide}
828 */
829 static final int FADING_EDGE_VERTICAL = 0x00002000;
830
831 /**
832 * <p>Mask for use with setFlags indicating bits used for indicating which
833 * fading edges are enabled.</p>
834 * {@hide}
835 */
836 static final int FADING_EDGE_MASK = 0x00003000;
837
838 /**
839 * <p>Indicates this view can be clicked. When clickable, a View reacts
840 * to clicks by notifying the OnClickListener.<p>
841 * {@hide}
842 */
843 static final int CLICKABLE = 0x00004000;
844
845 /**
846 * <p>Indicates this view is caching its drawing into a bitmap.</p>
847 * {@hide}
848 */
849 static final int DRAWING_CACHE_ENABLED = 0x00008000;
850
851 /**
852 * <p>Indicates that no icicle should be saved for this view.<p>
853 * {@hide}
854 */
855 static final int SAVE_DISABLED = 0x000010000;
856
857 /**
858 * <p>Mask for use with setFlags indicating bits used for the saveEnabled
859 * property.</p>
860 * {@hide}
861 */
862 static final int SAVE_DISABLED_MASK = 0x000010000;
863
864 /**
865 * <p>Indicates that no drawing cache should ever be created for this view.<p>
866 * {@hide}
867 */
868 static final int WILL_NOT_CACHE_DRAWING = 0x000020000;
869
870 /**
871 * <p>Indicates this view can take / keep focus when int touch mode.</p>
872 * {@hide}
873 */
874 static final int FOCUSABLE_IN_TOUCH_MODE = 0x00040000;
875
876 /**
877 * <p>Enables low quality mode for the drawing cache.</p>
878 */
879 public static final int DRAWING_CACHE_QUALITY_LOW = 0x00080000;
880
881 /**
882 * <p>Enables high quality mode for the drawing cache.</p>
883 */
884 public static final int DRAWING_CACHE_QUALITY_HIGH = 0x00100000;
885
886 /**
887 * <p>Enables automatic quality mode for the drawing cache.</p>
888 */
889 public static final int DRAWING_CACHE_QUALITY_AUTO = 0x00000000;
890
891 private static final int[] DRAWING_CACHE_QUALITY_FLAGS = {
892 DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_LOW, DRAWING_CACHE_QUALITY_HIGH
893 };
894
895 /**
896 * <p>Mask for use with setFlags indicating bits used for the cache
897 * quality property.</p>
898 * {@hide}
899 */
900 static final int DRAWING_CACHE_QUALITY_MASK = 0x00180000;
901
902 /**
903 * <p>
904 * Indicates this view can be long clicked. When long clickable, a View
905 * reacts to long clicks by notifying the OnLongClickListener or showing a
906 * context menu.
907 * </p>
908 * {@hide}
909 */
910 static final int LONG_CLICKABLE = 0x00200000;
911
912 /**
913 * <p>Indicates that this view gets its drawable states from its direct parent
914 * and ignores its original internal states.</p>
915 *
916 * @hide
917 */
918 static final int DUPLICATE_PARENT_STATE = 0x00400000;
919
920 /**
921 * The scrollbar style to display the scrollbars inside the content area,
922 * without increasing the padding. The scrollbars will be overlaid with
923 * translucency on the view's content.
924 */
925 public static final int SCROLLBARS_INSIDE_OVERLAY = 0;
926
927 /**
928 * The scrollbar style to display the scrollbars inside the padded area,
929 * increasing the padding of the view. The scrollbars will not overlap the
930 * content area of the view.
931 */
932 public static final int SCROLLBARS_INSIDE_INSET = 0x01000000;
933
934 /**
935 * The scrollbar style to display the scrollbars at the edge of the view,
936 * without increasing the padding. The scrollbars will be overlaid with
937 * translucency.
938 */
939 public static final int SCROLLBARS_OUTSIDE_OVERLAY = 0x02000000;
940
941 /**
942 * The scrollbar style to display the scrollbars at the edge of the view,
943 * increasing the padding of the view. The scrollbars will only overlap the
944 * background, if any.
945 */
946 public static final int SCROLLBARS_OUTSIDE_INSET = 0x03000000;
947
948 /**
949 * Mask to check if the scrollbar style is overlay or inset.
950 * {@hide}
951 */
952 static final int SCROLLBARS_INSET_MASK = 0x01000000;
953
954 /**
955 * Mask to check if the scrollbar style is inside or outside.
956 * {@hide}
957 */
958 static final int SCROLLBARS_OUTSIDE_MASK = 0x02000000;
959
960 /**
961 * Mask for scrollbar style.
962 * {@hide}
963 */
964 static final int SCROLLBARS_STYLE_MASK = 0x03000000;
965
966 /**
967 * View flag indicating that the screen should remain on while the
968 * window containing this view is visible to the user. This effectively
969 * takes care of automatically setting the WindowManager's
970 * {@link WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON}.
971 */
972 public static final int KEEP_SCREEN_ON = 0x04000000;
973
974 /**
975 * View flag indicating whether this view should have sound effects enabled
976 * for events such as clicking and touching.
977 */
978 public static final int SOUND_EFFECTS_ENABLED = 0x08000000;
979
980 /**
981 * View flag indicating whether this view should have haptic feedback
982 * enabled for events such as long presses.
983 */
984 public static final int HAPTIC_FEEDBACK_ENABLED = 0x10000000;
985
986 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700987 * <p>Indicates that the view hierarchy should stop saving state when
988 * it reaches this view. If state saving is initiated immediately at
989 * the view, it will be allowed.
990 * {@hide}
991 */
992 static final int PARENT_SAVE_DISABLED = 0x20000000;
993
994 /**
995 * <p>Mask for use with setFlags indicating bits used for PARENT_SAVE_DISABLED.</p>
996 * {@hide}
997 */
998 static final int PARENT_SAVE_DISABLED_MASK = 0x20000000;
999
1000 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07001001 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)}
1002 * should add all focusable Views regardless if they are focusable in touch mode.
1003 */
1004 public static final int FOCUSABLES_ALL = 0x00000000;
1005
1006 /**
1007 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)}
1008 * should add only Views focusable in touch mode.
1009 */
1010 public static final int FOCUSABLES_TOUCH_MODE = 0x00000001;
1011
1012 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001013 * Use with {@link #focusSearch(int)}. Move focus to the previous selectable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001014 * item.
1015 */
1016 public static final int FOCUS_BACKWARD = 0x00000001;
1017
1018 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001019 * Use with {@link #focusSearch(int)}. Move focus to the next selectable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001020 * item.
1021 */
1022 public static final int FOCUS_FORWARD = 0x00000002;
1023
1024 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001025 * Use with {@link #focusSearch(int)}. Move focus to the left.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001026 */
1027 public static final int FOCUS_LEFT = 0x00000011;
1028
1029 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001030 * Use with {@link #focusSearch(int)}. Move focus up.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001031 */
1032 public static final int FOCUS_UP = 0x00000021;
1033
1034 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001035 * Use with {@link #focusSearch(int)}. Move focus to the right.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001036 */
1037 public static final int FOCUS_RIGHT = 0x00000042;
1038
1039 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001040 * Use with {@link #focusSearch(int)}. Move focus down.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001041 */
1042 public static final int FOCUS_DOWN = 0x00000082;
1043
Svetoslav Ganov42138042012-03-20 11:51:39 -07001044 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08001045 * Bits of {@link #getMeasuredWidthAndState()} and
1046 * {@link #getMeasuredWidthAndState()} that provide the actual measured size.
1047 */
1048 public static final int MEASURED_SIZE_MASK = 0x00ffffff;
1049
1050 /**
1051 * Bits of {@link #getMeasuredWidthAndState()} and
1052 * {@link #getMeasuredWidthAndState()} that provide the additional state bits.
1053 */
1054 public static final int MEASURED_STATE_MASK = 0xff000000;
1055
1056 /**
1057 * Bit shift of {@link #MEASURED_STATE_MASK} to get to the height bits
1058 * for functions that combine both width and height into a single int,
1059 * such as {@link #getMeasuredState()} and the childState argument of
1060 * {@link #resolveSizeAndState(int, int, int)}.
1061 */
1062 public static final int MEASURED_HEIGHT_STATE_SHIFT = 16;
1063
1064 /**
1065 * Bit of {@link #getMeasuredWidthAndState()} and
1066 * {@link #getMeasuredWidthAndState()} that indicates the measured size
1067 * is smaller that the space the view would like to have.
1068 */
1069 public static final int MEASURED_STATE_TOO_SMALL = 0x01000000;
1070
1071 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001072 * Base View state sets
1073 */
1074 // Singles
1075 /**
1076 * Indicates the view has no states set. States are used with
1077 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1078 * view depending on its state.
1079 *
1080 * @see android.graphics.drawable.Drawable
1081 * @see #getDrawableState()
1082 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001083 protected static final int[] EMPTY_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001084 /**
1085 * Indicates the view is enabled. States are used with
1086 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1087 * view depending on its state.
1088 *
1089 * @see android.graphics.drawable.Drawable
1090 * @see #getDrawableState()
1091 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001092 protected static final int[] ENABLED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001093 /**
1094 * Indicates the view is focused. States are used with
1095 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1096 * view depending on its state.
1097 *
1098 * @see android.graphics.drawable.Drawable
1099 * @see #getDrawableState()
1100 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001101 protected static final int[] FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001102 /**
1103 * Indicates the view is selected. States are used with
1104 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1105 * view depending on its state.
1106 *
1107 * @see android.graphics.drawable.Drawable
1108 * @see #getDrawableState()
1109 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001110 protected static final int[] SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001111 /**
1112 * Indicates the view is pressed. States are used with
1113 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1114 * view depending on its state.
1115 *
1116 * @see android.graphics.drawable.Drawable
1117 * @see #getDrawableState()
1118 * @hide
1119 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001120 protected static final int[] PRESSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001121 /**
1122 * Indicates the view's window has focus. States are used with
1123 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1124 * view depending on its state.
1125 *
1126 * @see android.graphics.drawable.Drawable
1127 * @see #getDrawableState()
1128 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001129 protected static final int[] WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001130 // Doubles
1131 /**
1132 * Indicates the view is enabled and has the focus.
1133 *
1134 * @see #ENABLED_STATE_SET
1135 * @see #FOCUSED_STATE_SET
1136 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001137 protected static final int[] ENABLED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001138 /**
1139 * Indicates the view is enabled and selected.
1140 *
1141 * @see #ENABLED_STATE_SET
1142 * @see #SELECTED_STATE_SET
1143 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001144 protected static final int[] ENABLED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001145 /**
1146 * Indicates the view is enabled and that its window has focus.
1147 *
1148 * @see #ENABLED_STATE_SET
1149 * @see #WINDOW_FOCUSED_STATE_SET
1150 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001151 protected static final int[] ENABLED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001152 /**
1153 * Indicates the view is focused and selected.
1154 *
1155 * @see #FOCUSED_STATE_SET
1156 * @see #SELECTED_STATE_SET
1157 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001158 protected static final int[] FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001159 /**
1160 * Indicates the view has the focus and that its window has the focus.
1161 *
1162 * @see #FOCUSED_STATE_SET
1163 * @see #WINDOW_FOCUSED_STATE_SET
1164 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001165 protected static final int[] FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001166 /**
1167 * Indicates the view is selected and that its window has the focus.
1168 *
1169 * @see #SELECTED_STATE_SET
1170 * @see #WINDOW_FOCUSED_STATE_SET
1171 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001172 protected static final int[] SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001173 // Triples
1174 /**
1175 * Indicates the view is enabled, focused and selected.
1176 *
1177 * @see #ENABLED_STATE_SET
1178 * @see #FOCUSED_STATE_SET
1179 * @see #SELECTED_STATE_SET
1180 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001181 protected static final int[] ENABLED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001182 /**
1183 * Indicates the view is enabled, focused and its window has the focus.
1184 *
1185 * @see #ENABLED_STATE_SET
1186 * @see #FOCUSED_STATE_SET
1187 * @see #WINDOW_FOCUSED_STATE_SET
1188 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001189 protected static final int[] ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001190 /**
1191 * Indicates the view is enabled, selected and its window has the focus.
1192 *
1193 * @see #ENABLED_STATE_SET
1194 * @see #SELECTED_STATE_SET
1195 * @see #WINDOW_FOCUSED_STATE_SET
1196 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001197 protected static final int[] ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001198 /**
1199 * Indicates the view is focused, selected and its window has the focus.
1200 *
1201 * @see #FOCUSED_STATE_SET
1202 * @see #SELECTED_STATE_SET
1203 * @see #WINDOW_FOCUSED_STATE_SET
1204 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001205 protected static final int[] FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001206 /**
1207 * Indicates the view is enabled, focused, selected and its window
1208 * has the focus.
1209 *
1210 * @see #ENABLED_STATE_SET
1211 * @see #FOCUSED_STATE_SET
1212 * @see #SELECTED_STATE_SET
1213 * @see #WINDOW_FOCUSED_STATE_SET
1214 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001215 protected static final int[] ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001216 /**
1217 * Indicates the view is pressed and its window has the focus.
1218 *
1219 * @see #PRESSED_STATE_SET
1220 * @see #WINDOW_FOCUSED_STATE_SET
1221 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001222 protected static final int[] PRESSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001223 /**
1224 * Indicates the view is pressed and selected.
1225 *
1226 * @see #PRESSED_STATE_SET
1227 * @see #SELECTED_STATE_SET
1228 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001229 protected static final int[] PRESSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001230 /**
1231 * Indicates the view is pressed, selected and its window has the focus.
1232 *
1233 * @see #PRESSED_STATE_SET
1234 * @see #SELECTED_STATE_SET
1235 * @see #WINDOW_FOCUSED_STATE_SET
1236 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001237 protected static final int[] PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001238 /**
1239 * Indicates the view is pressed and focused.
1240 *
1241 * @see #PRESSED_STATE_SET
1242 * @see #FOCUSED_STATE_SET
1243 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001244 protected static final int[] PRESSED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001245 /**
1246 * Indicates the view is pressed, focused and its window has the focus.
1247 *
1248 * @see #PRESSED_STATE_SET
1249 * @see #FOCUSED_STATE_SET
1250 * @see #WINDOW_FOCUSED_STATE_SET
1251 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001252 protected static final int[] PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001253 /**
1254 * Indicates the view is pressed, focused and selected.
1255 *
1256 * @see #PRESSED_STATE_SET
1257 * @see #SELECTED_STATE_SET
1258 * @see #FOCUSED_STATE_SET
1259 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001260 protected static final int[] PRESSED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001261 /**
1262 * Indicates the view is pressed, focused, selected and its window has the focus.
1263 *
1264 * @see #PRESSED_STATE_SET
1265 * @see #FOCUSED_STATE_SET
1266 * @see #SELECTED_STATE_SET
1267 * @see #WINDOW_FOCUSED_STATE_SET
1268 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001269 protected static final int[] PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001270 /**
1271 * Indicates the view is pressed and enabled.
1272 *
1273 * @see #PRESSED_STATE_SET
1274 * @see #ENABLED_STATE_SET
1275 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001276 protected static final int[] PRESSED_ENABLED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001277 /**
1278 * Indicates the view is pressed, enabled and its window has the focus.
1279 *
1280 * @see #PRESSED_STATE_SET
1281 * @see #ENABLED_STATE_SET
1282 * @see #WINDOW_FOCUSED_STATE_SET
1283 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001284 protected static final int[] PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001285 /**
1286 * Indicates the view is pressed, enabled and selected.
1287 *
1288 * @see #PRESSED_STATE_SET
1289 * @see #ENABLED_STATE_SET
1290 * @see #SELECTED_STATE_SET
1291 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001292 protected static final int[] PRESSED_ENABLED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001293 /**
1294 * Indicates the view is pressed, enabled, selected and its window has the
1295 * focus.
1296 *
1297 * @see #PRESSED_STATE_SET
1298 * @see #ENABLED_STATE_SET
1299 * @see #SELECTED_STATE_SET
1300 * @see #WINDOW_FOCUSED_STATE_SET
1301 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001302 protected static final int[] PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001303 /**
1304 * Indicates the view is pressed, enabled and focused.
1305 *
1306 * @see #PRESSED_STATE_SET
1307 * @see #ENABLED_STATE_SET
1308 * @see #FOCUSED_STATE_SET
1309 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001310 protected static final int[] PRESSED_ENABLED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001311 /**
1312 * Indicates the view is pressed, enabled, focused and its window has the
1313 * focus.
1314 *
1315 * @see #PRESSED_STATE_SET
1316 * @see #ENABLED_STATE_SET
1317 * @see #FOCUSED_STATE_SET
1318 * @see #WINDOW_FOCUSED_STATE_SET
1319 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001320 protected static final int[] PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001321 /**
1322 * Indicates the view is pressed, enabled, focused and selected.
1323 *
1324 * @see #PRESSED_STATE_SET
1325 * @see #ENABLED_STATE_SET
1326 * @see #SELECTED_STATE_SET
1327 * @see #FOCUSED_STATE_SET
1328 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001329 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001330 /**
1331 * Indicates the view is pressed, enabled, focused, selected and its window
1332 * has the focus.
1333 *
1334 * @see #PRESSED_STATE_SET
1335 * @see #ENABLED_STATE_SET
1336 * @see #SELECTED_STATE_SET
1337 * @see #FOCUSED_STATE_SET
1338 * @see #WINDOW_FOCUSED_STATE_SET
1339 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001340 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001341
1342 /**
1343 * The order here is very important to {@link #getDrawableState()}
1344 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001345 private static final int[][] VIEW_STATE_SETS;
1346
Romain Guyb051e892010-09-28 19:09:36 -07001347 static final int VIEW_STATE_WINDOW_FOCUSED = 1;
1348 static final int VIEW_STATE_SELECTED = 1 << 1;
1349 static final int VIEW_STATE_FOCUSED = 1 << 2;
1350 static final int VIEW_STATE_ENABLED = 1 << 3;
1351 static final int VIEW_STATE_PRESSED = 1 << 4;
1352 static final int VIEW_STATE_ACTIVATED = 1 << 5;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08001353 static final int VIEW_STATE_ACCELERATED = 1 << 6;
PY Laligandc33d8d49e2011-03-14 18:22:53 -07001354 static final int VIEW_STATE_HOVERED = 1 << 7;
Christopher Tate3d4bf172011-03-28 16:16:46 -07001355 static final int VIEW_STATE_DRAG_CAN_ACCEPT = 1 << 8;
1356 static final int VIEW_STATE_DRAG_HOVERED = 1 << 9;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001357
1358 static final int[] VIEW_STATE_IDS = new int[] {
1359 R.attr.state_window_focused, VIEW_STATE_WINDOW_FOCUSED,
1360 R.attr.state_selected, VIEW_STATE_SELECTED,
1361 R.attr.state_focused, VIEW_STATE_FOCUSED,
1362 R.attr.state_enabled, VIEW_STATE_ENABLED,
1363 R.attr.state_pressed, VIEW_STATE_PRESSED,
1364 R.attr.state_activated, VIEW_STATE_ACTIVATED,
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08001365 R.attr.state_accelerated, VIEW_STATE_ACCELERATED,
PY Laligandc33d8d49e2011-03-14 18:22:53 -07001366 R.attr.state_hovered, VIEW_STATE_HOVERED,
Christopher Tate3d4bf172011-03-28 16:16:46 -07001367 R.attr.state_drag_can_accept, VIEW_STATE_DRAG_CAN_ACCEPT,
Svetoslav Ganov42138042012-03-20 11:51:39 -07001368 R.attr.state_drag_hovered, VIEW_STATE_DRAG_HOVERED
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001369 };
1370
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001371 static {
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08001372 if ((VIEW_STATE_IDS.length/2) != R.styleable.ViewDrawableStates.length) {
1373 throw new IllegalStateException(
1374 "VIEW_STATE_IDs array length does not match ViewDrawableStates style array");
1375 }
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001376 int[] orderedIds = new int[VIEW_STATE_IDS.length];
Romain Guyb051e892010-09-28 19:09:36 -07001377 for (int i = 0; i < R.styleable.ViewDrawableStates.length; i++) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001378 int viewState = R.styleable.ViewDrawableStates[i];
Romain Guyb051e892010-09-28 19:09:36 -07001379 for (int j = 0; j<VIEW_STATE_IDS.length; j += 2) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001380 if (VIEW_STATE_IDS[j] == viewState) {
Romain Guyb051e892010-09-28 19:09:36 -07001381 orderedIds[i * 2] = viewState;
1382 orderedIds[i * 2 + 1] = VIEW_STATE_IDS[j + 1];
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001383 }
1384 }
1385 }
Romain Guyb051e892010-09-28 19:09:36 -07001386 final int NUM_BITS = VIEW_STATE_IDS.length / 2;
1387 VIEW_STATE_SETS = new int[1 << NUM_BITS][];
1388 for (int i = 0; i < VIEW_STATE_SETS.length; i++) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001389 int numBits = Integer.bitCount(i);
1390 int[] set = new int[numBits];
1391 int pos = 0;
Romain Guyb051e892010-09-28 19:09:36 -07001392 for (int j = 0; j < orderedIds.length; j += 2) {
1393 if ((i & orderedIds[j+1]) != 0) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001394 set[pos++] = orderedIds[j];
1395 }
1396 }
1397 VIEW_STATE_SETS[i] = set;
1398 }
1399
1400 EMPTY_STATE_SET = VIEW_STATE_SETS[0];
1401 WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_WINDOW_FOCUSED];
1402 SELECTED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_SELECTED];
1403 SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1404 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED];
1405 FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_FOCUSED];
1406 FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1407 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED];
1408 FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1409 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED];
1410 FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1411 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1412 | VIEW_STATE_FOCUSED];
1413 ENABLED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_ENABLED];
1414 ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1415 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED];
1416 ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1417 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED];
1418 ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1419 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1420 | VIEW_STATE_ENABLED];
1421 ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1422 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED];
1423 ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1424 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1425 | VIEW_STATE_ENABLED];
1426 ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1427 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1428 | VIEW_STATE_ENABLED];
1429 ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1430 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1431 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED];
1432
1433 PRESSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_PRESSED];
1434 PRESSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1435 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_PRESSED];
1436 PRESSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1437 VIEW_STATE_SELECTED | VIEW_STATE_PRESSED];
1438 PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1439 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1440 | VIEW_STATE_PRESSED];
1441 PRESSED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1442 VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED];
1443 PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1444 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1445 | VIEW_STATE_PRESSED];
1446 PRESSED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1447 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1448 | VIEW_STATE_PRESSED];
1449 PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1450 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1451 | VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED];
1452 PRESSED_ENABLED_STATE_SET = VIEW_STATE_SETS[
1453 VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1454 PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1455 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED
1456 | VIEW_STATE_PRESSED];
1457 PRESSED_ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1458 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED
1459 | VIEW_STATE_PRESSED];
1460 PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1461 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1462 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1463 PRESSED_ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1464 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED
1465 | VIEW_STATE_PRESSED];
1466 PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1467 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1468 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1469 PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1470 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1471 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1472 PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1473 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1474 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED
1475 | VIEW_STATE_PRESSED];
1476 }
1477
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001478 /**
Svetoslav Ganov82e236d2011-09-29 19:31:06 -07001479 * Accessibility event types that are dispatched for text population.
1480 */
1481 private static final int POPULATING_ACCESSIBILITY_EVENT_TYPES =
1482 AccessibilityEvent.TYPE_VIEW_CLICKED
1483 | AccessibilityEvent.TYPE_VIEW_LONG_CLICKED
1484 | AccessibilityEvent.TYPE_VIEW_SELECTED
1485 | AccessibilityEvent.TYPE_VIEW_FOCUSED
1486 | AccessibilityEvent.TYPE_WINDOW_STATE_CHANGED
1487 | AccessibilityEvent.TYPE_VIEW_HOVER_ENTER
Svetoslav Ganov9920f4f2011-10-07 18:39:11 -07001488 | AccessibilityEvent.TYPE_VIEW_HOVER_EXIT
Svetoslav Ganov84dd52e2011-11-18 10:24:00 -08001489 | AccessibilityEvent.TYPE_VIEW_TEXT_CHANGED
Svetoslav Ganov42138042012-03-20 11:51:39 -07001490 | AccessibilityEvent.TYPE_VIEW_TEXT_SELECTION_CHANGED
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07001491 | AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED
1492 | AccessibilityEvent.TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY;
Svetoslav Ganov82e236d2011-09-29 19:31:06 -07001493
1494 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001495 * Temporary Rect currently for use in setBackground(). This will probably
1496 * be extended in the future to hold our own class with more than just
1497 * a Rect. :)
1498 */
1499 static final ThreadLocal<Rect> sThreadLocal = new ThreadLocal<Rect>();
Romain Guyd90a3312009-05-06 14:54:28 -07001500
1501 /**
1502 * Map used to store views' tags.
1503 */
Adam Powell7db82ac2011-09-22 19:44:04 -07001504 private SparseArray<Object> mKeyedTags;
Romain Guyd90a3312009-05-06 14:54:28 -07001505
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001506 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07001507 * The next available accessiiblity id.
1508 */
1509 private static int sNextAccessibilityViewId;
1510
1511 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001512 * The animation currently associated with this view.
1513 * @hide
1514 */
1515 protected Animation mCurrentAnimation = null;
1516
1517 /**
1518 * Width as measured during measure pass.
1519 * {@hide}
1520 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001521 @ViewDebug.ExportedProperty(category = "measurement")
Romain Guy676b1732011-02-14 14:45:33 -08001522 int mMeasuredWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001523
1524 /**
1525 * Height as measured during measure pass.
1526 * {@hide}
1527 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001528 @ViewDebug.ExportedProperty(category = "measurement")
Romain Guy676b1732011-02-14 14:45:33 -08001529 int mMeasuredHeight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001530
1531 /**
Chet Haasedaf98e92011-01-10 14:10:36 -08001532 * Flag to indicate that this view was marked INVALIDATED, or had its display list
1533 * invalidated, prior to the current drawing iteration. If true, the view must re-draw
1534 * its display list. This flag, used only when hw accelerated, allows us to clear the
1535 * flag while retaining this information until it's needed (at getDisplayList() time and
1536 * in drawChild(), when we decide to draw a view's children's display lists into our own).
1537 *
1538 * {@hide}
1539 */
1540 boolean mRecreateDisplayList = false;
1541
1542 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001543 * The view's identifier.
1544 * {@hide}
1545 *
1546 * @see #setId(int)
1547 * @see #getId()
1548 */
1549 @ViewDebug.ExportedProperty(resolveId = true)
1550 int mID = NO_ID;
1551
1552 /**
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07001553 * The stable ID of this view for accessibility purposes.
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07001554 */
1555 int mAccessibilityViewId = NO_ID;
1556
1557 /**
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07001558 * @hide
1559 */
Svetoslav Ganov39f2aee2012-05-29 09:15:30 -07001560 private int mAccessibilityCursorPosition = ACCESSIBILITY_CURSOR_POSITION_UNDEFINED;
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07001561
1562 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001563 * The view's tag.
1564 * {@hide}
1565 *
1566 * @see #setTag(Object)
1567 * @see #getTag()
1568 */
1569 protected Object mTag;
1570
1571 // for mPrivateFlags:
1572 /** {@hide} */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001573 static final int PFLAG_WANTS_FOCUS = 0x00000001;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001574 /** {@hide} */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001575 static final int PFLAG_FOCUSED = 0x00000002;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001576 /** {@hide} */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001577 static final int PFLAG_SELECTED = 0x00000004;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001578 /** {@hide} */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001579 static final int PFLAG_IS_ROOT_NAMESPACE = 0x00000008;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001580 /** {@hide} */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001581 static final int PFLAG_HAS_BOUNDS = 0x00000010;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001582 /** {@hide} */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001583 static final int PFLAG_DRAWN = 0x00000020;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001584 /**
1585 * When this flag is set, this view is running an animation on behalf of its
1586 * children and should therefore not cancel invalidate requests, even if they
1587 * lie outside of this view's bounds.
1588 *
1589 * {@hide}
1590 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001591 static final int PFLAG_DRAW_ANIMATION = 0x00000040;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001592 /** {@hide} */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001593 static final int PFLAG_SKIP_DRAW = 0x00000080;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001594 /** {@hide} */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001595 static final int PFLAG_ONLY_DRAWS_BACKGROUND = 0x00000100;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001596 /** {@hide} */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001597 static final int PFLAG_REQUEST_TRANSPARENT_REGIONS = 0x00000200;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001598 /** {@hide} */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001599 static final int PFLAG_DRAWABLE_STATE_DIRTY = 0x00000400;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001600 /** {@hide} */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001601 static final int PFLAG_MEASURED_DIMENSION_SET = 0x00000800;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001602 /** {@hide} */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001603 static final int PFLAG_FORCE_LAYOUT = 0x00001000;
Konstantin Lopyrevc6dc4572010-08-06 15:01:52 -07001604 /** {@hide} */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001605 static final int PFLAG_LAYOUT_REQUIRED = 0x00002000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001606
Dianne Hackborn4702a852012-08-17 15:18:29 -07001607 private static final int PFLAG_PRESSED = 0x00004000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001608
1609 /** {@hide} */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001610 static final int PFLAG_DRAWING_CACHE_VALID = 0x00008000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001611 /**
1612 * Flag used to indicate that this view should be drawn once more (and only once
1613 * more) after its animation has completed.
1614 * {@hide}
1615 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001616 static final int PFLAG_ANIMATION_STARTED = 0x00010000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001617
Dianne Hackborn4702a852012-08-17 15:18:29 -07001618 private static final int PFLAG_SAVE_STATE_CALLED = 0x00020000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001619
1620 /**
1621 * Indicates that the View returned true when onSetAlpha() was called and that
1622 * the alpha must be restored.
1623 * {@hide}
1624 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001625 static final int PFLAG_ALPHA_SET = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001626
1627 /**
1628 * Set by {@link #setScrollContainer(boolean)}.
1629 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001630 static final int PFLAG_SCROLL_CONTAINER = 0x00080000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001631
1632 /**
1633 * Set by {@link #setScrollContainer(boolean)}.
1634 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001635 static final int PFLAG_SCROLL_CONTAINER_ADDED = 0x00100000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001636
1637 /**
Romain Guy809a7f62009-05-14 15:44:42 -07001638 * View flag indicating whether this view was invalidated (fully or partially.)
1639 *
1640 * @hide
1641 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001642 static final int PFLAG_DIRTY = 0x00200000;
Romain Guy809a7f62009-05-14 15:44:42 -07001643
1644 /**
1645 * View flag indicating whether this view was invalidated by an opaque
1646 * invalidate request.
1647 *
1648 * @hide
1649 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001650 static final int PFLAG_DIRTY_OPAQUE = 0x00400000;
Romain Guy809a7f62009-05-14 15:44:42 -07001651
1652 /**
Dianne Hackborn4702a852012-08-17 15:18:29 -07001653 * Mask for {@link #PFLAG_DIRTY} and {@link #PFLAG_DIRTY_OPAQUE}.
Romain Guy809a7f62009-05-14 15:44:42 -07001654 *
1655 * @hide
1656 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001657 static final int PFLAG_DIRTY_MASK = 0x00600000;
Romain Guy809a7f62009-05-14 15:44:42 -07001658
1659 /**
Romain Guy8f1344f52009-05-15 16:03:59 -07001660 * Indicates whether the background is opaque.
1661 *
1662 * @hide
1663 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001664 static final int PFLAG_OPAQUE_BACKGROUND = 0x00800000;
Romain Guy8f1344f52009-05-15 16:03:59 -07001665
1666 /**
1667 * Indicates whether the scrollbars are opaque.
1668 *
1669 * @hide
1670 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001671 static final int PFLAG_OPAQUE_SCROLLBARS = 0x01000000;
Romain Guy8f1344f52009-05-15 16:03:59 -07001672
1673 /**
1674 * Indicates whether the view is opaque.
1675 *
1676 * @hide
1677 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001678 static final int PFLAG_OPAQUE_MASK = 0x01800000;
Joe Malin32736f02011-01-19 16:14:20 -08001679
Adam Powelle14579b2009-12-16 18:39:52 -08001680 /**
1681 * Indicates a prepressed state;
1682 * the short time between ACTION_DOWN and recognizing
1683 * a 'real' press. Prepressed is used to recognize quick taps
1684 * even when they are shorter than ViewConfiguration.getTapTimeout().
Joe Malin32736f02011-01-19 16:14:20 -08001685 *
Adam Powelle14579b2009-12-16 18:39:52 -08001686 * @hide
1687 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001688 private static final int PFLAG_PREPRESSED = 0x02000000;
Joe Malin32736f02011-01-19 16:14:20 -08001689
Adam Powellc9fbaab2010-02-16 17:16:19 -08001690 /**
Romain Guy8afa5152010-02-26 11:56:30 -08001691 * Indicates whether the view is temporarily detached.
1692 *
1693 * @hide
1694 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001695 static final int PFLAG_CANCEL_NEXT_UP_EVENT = 0x04000000;
Joe Malin32736f02011-01-19 16:14:20 -08001696
Adam Powell8568c3a2010-04-19 14:26:11 -07001697 /**
1698 * Indicates that we should awaken scroll bars once attached
Joe Malin32736f02011-01-19 16:14:20 -08001699 *
Adam Powell8568c3a2010-04-19 14:26:11 -07001700 * @hide
1701 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001702 private static final int PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH = 0x08000000;
Romain Guy8f1344f52009-05-15 16:03:59 -07001703
1704 /**
Jeff Browna032cc02011-03-07 16:56:21 -08001705 * Indicates that the view has received HOVER_ENTER. Cleared on HOVER_EXIT.
1706 * @hide
1707 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001708 private static final int PFLAG_HOVERED = 0x10000000;
Jeff Browna032cc02011-03-07 16:56:21 -08001709
1710 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07001711 * Indicates that pivotX or pivotY were explicitly set and we should not assume the center
1712 * for transform operations
1713 *
1714 * @hide
1715 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001716 private static final int PFLAG_PIVOT_EXPLICITLY_SET = 0x20000000;
Chet Haasefd2b0022010-08-06 13:08:56 -07001717
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001718 /** {@hide} */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001719 static final int PFLAG_ACTIVATED = 0x40000000;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001720
Chet Haasefd2b0022010-08-06 13:08:56 -07001721 /**
Chet Haasedaf98e92011-01-10 14:10:36 -08001722 * Indicates that this view was specifically invalidated, not just dirtied because some
1723 * child view was invalidated. The flag is used to determine when we need to recreate
1724 * a view's display list (as opposed to just returning a reference to its existing
1725 * display list).
1726 *
1727 * @hide
1728 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001729 static final int PFLAG_INVALIDATED = 0x80000000;
Chet Haasedaf98e92011-01-10 14:10:36 -08001730
Christopher Tate3d4bf172011-03-28 16:16:46 -07001731 /* Masks for mPrivateFlags2 */
1732
1733 /**
1734 * Indicates that this view has reported that it can accept the current drag's content.
1735 * Cleared when the drag operation concludes.
1736 * @hide
1737 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001738 static final int PFLAG2_DRAG_CAN_ACCEPT = 0x00000001;
Christopher Tate3d4bf172011-03-28 16:16:46 -07001739
1740 /**
1741 * Indicates that this view is currently directly under the drag location in a
1742 * drag-and-drop operation involving content that it can accept. Cleared when
1743 * the drag exits the view, or when the drag operation concludes.
1744 * @hide
1745 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001746 static final int PFLAG2_DRAG_HOVERED = 0x00000002;
Christopher Tate3d4bf172011-03-28 16:16:46 -07001747
Cibu Johny86666632010-02-22 13:01:02 -08001748 /**
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001749 * Horizontal layout direction of this view is from Left to Right.
1750 * Use with {@link #setLayoutDirection}.
Cibu Johny86666632010-02-22 13:01:02 -08001751 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001752 public static final int LAYOUT_DIRECTION_LTR = 0;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07001753
1754 /**
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001755 * Horizontal layout direction of this view is from Right to Left.
1756 * Use with {@link #setLayoutDirection}.
1757 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001758 public static final int LAYOUT_DIRECTION_RTL = 1;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001759
1760 /**
1761 * Horizontal layout direction of this view is inherited from its parent.
1762 * Use with {@link #setLayoutDirection}.
1763 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001764 public static final int LAYOUT_DIRECTION_INHERIT = 2;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001765
1766 /**
1767 * Horizontal layout direction of this view is from deduced from the default language
1768 * script for the locale. Use with {@link #setLayoutDirection}.
1769 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001770 public static final int LAYOUT_DIRECTION_LOCALE = 3;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001771
1772 /**
1773 * Bit shift to get the horizontal layout direction. (bits after DRAG_HOVERED)
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07001774 * @hide
1775 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001776 static final int PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT = 2;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001777
1778 /**
1779 * Mask for use with private flags indicating bits used for horizontal layout direction.
1780 * @hide
1781 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001782 static final int PFLAG2_LAYOUT_DIRECTION_MASK = 0x00000003 << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001783
1784 /**
1785 * Indicates whether the view horizontal layout direction has been resolved and drawn to the
1786 * right-to-left direction.
1787 * @hide
1788 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001789 static final int PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL = 4 << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001790
1791 /**
1792 * Indicates whether the view horizontal layout direction has been resolved.
1793 * @hide
1794 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001795 static final int PFLAG2_LAYOUT_DIRECTION_RESOLVED = 8 << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001796
1797 /**
1798 * Mask for use with private flags indicating bits used for resolved horizontal layout direction.
1799 * @hide
1800 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001801 static final int PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK = 0x0000000C
1802 << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001803
1804 /*
1805 * Array of horizontal layout direction flags for mapping attribute "layoutDirection" to correct
1806 * flag value.
1807 * @hide
1808 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001809 private static final int[] LAYOUT_DIRECTION_FLAGS = {
1810 LAYOUT_DIRECTION_LTR,
1811 LAYOUT_DIRECTION_RTL,
1812 LAYOUT_DIRECTION_INHERIT,
1813 LAYOUT_DIRECTION_LOCALE
1814 };
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001815
1816 /**
1817 * Default horizontal layout direction.
1818 * @hide
1819 */
1820 private static final int LAYOUT_DIRECTION_DEFAULT = LAYOUT_DIRECTION_INHERIT;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07001821
Adam Powell539ee872012-02-03 19:00:49 -08001822 /**
1823 * Indicates that the view is tracking some sort of transient state
1824 * that the app should not need to be aware of, but that the framework
1825 * should take special care to preserve.
1826 *
1827 * @hide
1828 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001829 static final int PFLAG2_HAS_TRANSIENT_STATE = 0x00000100;
Adam Powell539ee872012-02-03 19:00:49 -08001830
1831
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001832 /**
1833 * Text direction is inherited thru {@link ViewGroup}
1834 */
1835 public static final int TEXT_DIRECTION_INHERIT = 0;
1836
1837 /**
1838 * Text direction is using "first strong algorithm". The first strong directional character
1839 * determines the paragraph direction. If there is no strong directional character, the
1840 * paragraph direction is the view's resolved layout direction.
1841 */
1842 public static final int TEXT_DIRECTION_FIRST_STRONG = 1;
1843
1844 /**
1845 * Text direction is using "any-RTL" algorithm. The paragraph direction is RTL if it contains
1846 * any strong RTL character, otherwise it is LTR if it contains any strong LTR characters.
1847 * If there are neither, the paragraph direction is the view's resolved layout direction.
1848 */
1849 public static final int TEXT_DIRECTION_ANY_RTL = 2;
1850
1851 /**
1852 * Text direction is forced to LTR.
1853 */
1854 public static final int TEXT_DIRECTION_LTR = 3;
1855
1856 /**
1857 * Text direction is forced to RTL.
1858 */
1859 public static final int TEXT_DIRECTION_RTL = 4;
1860
1861 /**
1862 * Text direction is coming from the system Locale.
1863 */
1864 public static final int TEXT_DIRECTION_LOCALE = 5;
1865
1866 /**
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07001867 * Default text direction is inherited
1868 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001869 public static int TEXT_DIRECTION_DEFAULT = TEXT_DIRECTION_INHERIT;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07001870
1871 /**
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001872 * Bit shift to get the horizontal layout direction. (bits after LAYOUT_DIRECTION_RESOLVED)
1873 * @hide
1874 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001875 static final int PFLAG2_TEXT_DIRECTION_MASK_SHIFT = 6;
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001876
1877 /**
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001878 * Mask for use with private flags indicating bits used for text direction.
1879 * @hide
1880 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001881 static final int PFLAG2_TEXT_DIRECTION_MASK = 0x00000007
1882 << PFLAG2_TEXT_DIRECTION_MASK_SHIFT;
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001883
1884 /**
1885 * Array of text direction flags for mapping attribute "textDirection" to correct
1886 * flag value.
1887 * @hide
1888 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001889 private static final int[] PFLAG2_TEXT_DIRECTION_FLAGS = {
1890 TEXT_DIRECTION_INHERIT << PFLAG2_TEXT_DIRECTION_MASK_SHIFT,
1891 TEXT_DIRECTION_FIRST_STRONG << PFLAG2_TEXT_DIRECTION_MASK_SHIFT,
1892 TEXT_DIRECTION_ANY_RTL << PFLAG2_TEXT_DIRECTION_MASK_SHIFT,
1893 TEXT_DIRECTION_LTR << PFLAG2_TEXT_DIRECTION_MASK_SHIFT,
1894 TEXT_DIRECTION_RTL << PFLAG2_TEXT_DIRECTION_MASK_SHIFT,
1895 TEXT_DIRECTION_LOCALE << PFLAG2_TEXT_DIRECTION_MASK_SHIFT
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001896 };
1897
1898 /**
1899 * Indicates whether the view text direction has been resolved.
1900 * @hide
1901 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001902 static final int PFLAG2_TEXT_DIRECTION_RESOLVED = 0x00000008
1903 << PFLAG2_TEXT_DIRECTION_MASK_SHIFT;
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001904
1905 /**
1906 * Bit shift to get the horizontal layout direction. (bits after DRAG_HOVERED)
1907 * @hide
1908 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001909 static final int PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT = 10;
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001910
1911 /**
1912 * Mask for use with private flags indicating bits used for resolved text direction.
1913 * @hide
1914 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001915 static final int PFLAG2_TEXT_DIRECTION_RESOLVED_MASK = 0x00000007
1916 << PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT;
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001917
1918 /**
1919 * Indicates whether the view text direction has been resolved to the "first strong" heuristic.
1920 * @hide
1921 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001922 static final int PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT =
1923 TEXT_DIRECTION_FIRST_STRONG << PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT;
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001924
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07001925 /*
1926 * Default text alignment. The text alignment of this View is inherited from its parent.
1927 * Use with {@link #setTextAlignment(int)}
1928 */
1929 public static final int TEXT_ALIGNMENT_INHERIT = 0;
1930
1931 /**
1932 * Default for the root view. The gravity determines the text alignment, ALIGN_NORMAL,
1933 * ALIGN_CENTER, or ALIGN_OPPOSITE, which are relative to each paragraph’s text direction.
1934 *
1935 * Use with {@link #setTextAlignment(int)}
1936 */
1937 public static final int TEXT_ALIGNMENT_GRAVITY = 1;
1938
1939 /**
1940 * Align to the start of the paragraph, e.g. ALIGN_NORMAL.
1941 *
1942 * Use with {@link #setTextAlignment(int)}
1943 */
1944 public static final int TEXT_ALIGNMENT_TEXT_START = 2;
1945
1946 /**
1947 * Align to the end of the paragraph, e.g. ALIGN_OPPOSITE.
1948 *
1949 * Use with {@link #setTextAlignment(int)}
1950 */
1951 public static final int TEXT_ALIGNMENT_TEXT_END = 3;
1952
1953 /**
1954 * Center the paragraph, e.g. ALIGN_CENTER.
1955 *
1956 * Use with {@link #setTextAlignment(int)}
1957 */
1958 public static final int TEXT_ALIGNMENT_CENTER = 4;
1959
1960 /**
1961 * Align to the start of the view, which is ALIGN_LEFT if the view’s resolved
1962 * layoutDirection is LTR, and ALIGN_RIGHT otherwise.
1963 *
1964 * Use with {@link #setTextAlignment(int)}
1965 */
1966 public static final int TEXT_ALIGNMENT_VIEW_START = 5;
1967
1968 /**
1969 * Align to the end of the view, which is ALIGN_RIGHT if the view’s resolved
1970 * layoutDirection is LTR, and ALIGN_LEFT otherwise.
1971 *
1972 * Use with {@link #setTextAlignment(int)}
1973 */
1974 public static final int TEXT_ALIGNMENT_VIEW_END = 6;
1975
1976 /**
1977 * Default text alignment is inherited
1978 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001979 public static int TEXT_ALIGNMENT_DEFAULT = TEXT_ALIGNMENT_GRAVITY;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07001980
1981 /**
1982 * Bit shift to get the horizontal layout direction. (bits after DRAG_HOVERED)
1983 * @hide
1984 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001985 static final int PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT = 13;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07001986
1987 /**
1988 * Mask for use with private flags indicating bits used for text alignment.
1989 * @hide
1990 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001991 static final int PFLAG2_TEXT_ALIGNMENT_MASK = 0x00000007 << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07001992
1993 /**
1994 * Array of text direction flags for mapping attribute "textAlignment" to correct
1995 * flag value.
1996 * @hide
1997 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07001998 private static final int[] PFLAG2_TEXT_ALIGNMENT_FLAGS = {
1999 TEXT_ALIGNMENT_INHERIT << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT,
2000 TEXT_ALIGNMENT_GRAVITY << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT,
2001 TEXT_ALIGNMENT_TEXT_START << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT,
2002 TEXT_ALIGNMENT_TEXT_END << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT,
2003 TEXT_ALIGNMENT_CENTER << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT,
2004 TEXT_ALIGNMENT_VIEW_START << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT,
2005 TEXT_ALIGNMENT_VIEW_END << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07002006 };
2007
2008 /**
2009 * Indicates whether the view text alignment has been resolved.
2010 * @hide
2011 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07002012 static final int PFLAG2_TEXT_ALIGNMENT_RESOLVED = 0x00000008 << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07002013
2014 /**
2015 * Bit shift to get the resolved text alignment.
2016 * @hide
2017 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07002018 static final int PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT = 17;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07002019
2020 /**
2021 * Mask for use with private flags indicating bits used for text alignment.
2022 * @hide
2023 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07002024 static final int PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK = 0x00000007
2025 << PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07002026
2027 /**
2028 * Indicates whether if the view text alignment has been resolved to gravity
2029 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07002030 private static final int PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT =
2031 TEXT_ALIGNMENT_GRAVITY << PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07002032
Svetoslav Ganov42138042012-03-20 11:51:39 -07002033 // Accessiblity constants for mPrivateFlags2
2034
2035 /**
Svetoslav Ganovf9817f72012-05-22 18:10:31 -07002036 * Shift for the bits in {@link #mPrivateFlags2} related to the
2037 * "importantForAccessibility" attribute.
Svetoslav Ganov42138042012-03-20 11:51:39 -07002038 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07002039 static final int PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT = 20;
Svetoslav Ganov42138042012-03-20 11:51:39 -07002040
2041 /**
2042 * Automatically determine whether a view is important for accessibility.
2043 */
2044 public static final int IMPORTANT_FOR_ACCESSIBILITY_AUTO = 0x00000000;
2045
2046 /**
2047 * The view is important for accessibility.
2048 */
2049 public static final int IMPORTANT_FOR_ACCESSIBILITY_YES = 0x00000001;
2050
2051 /**
2052 * The view is not important for accessibility.
2053 */
2054 public static final int IMPORTANT_FOR_ACCESSIBILITY_NO = 0x00000002;
2055
2056 /**
2057 * The default whether the view is important for accessiblity.
2058 */
2059 static final int IMPORTANT_FOR_ACCESSIBILITY_DEFAULT = IMPORTANT_FOR_ACCESSIBILITY_AUTO;
2060
2061 /**
2062 * Mask for obtainig the bits which specify how to determine
2063 * whether a view is important for accessibility.
2064 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07002065 static final int PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK = (IMPORTANT_FOR_ACCESSIBILITY_AUTO
Svetoslav Ganov42138042012-03-20 11:51:39 -07002066 | IMPORTANT_FOR_ACCESSIBILITY_YES | IMPORTANT_FOR_ACCESSIBILITY_NO)
Dianne Hackborn4702a852012-08-17 15:18:29 -07002067 << PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT;
Svetoslav Ganov42138042012-03-20 11:51:39 -07002068
2069 /**
2070 * Flag indicating whether a view has accessibility focus.
2071 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07002072 static final int PFLAG2_ACCESSIBILITY_FOCUSED = 0x00000040 << PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT;
Svetoslav Ganov42138042012-03-20 11:51:39 -07002073
2074 /**
2075 * Flag indicating whether a view state for accessibility has changed.
2076 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07002077 static final int PFLAG2_ACCESSIBILITY_STATE_CHANGED = 0x00000080
2078 << PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT;
Fabrice Di Megliob934db72012-03-20 14:33:01 -07002079
Chet Haaseafd5c3e2012-05-10 13:21:10 -07002080 /**
Chet Haase1a3ab172012-05-11 08:41:20 -07002081 * Flag indicating whether a view failed the quickReject() check in draw(). This condition
2082 * is used to check whether later changes to the view's transform should invalidate the
2083 * view to force the quickReject test to run again.
2084 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07002085 static final int PFLAG2_VIEW_QUICK_REJECTED = 0x10000000;
Chet Haase1a3ab172012-05-11 08:41:20 -07002086
Adam Powell0090f202012-08-07 17:15:30 -07002087 /**
2088 * Flag indicating that start/end padding has been resolved into left/right padding
2089 * for use in measurement, layout, drawing, etc. This is set by {@link #resolvePadding()}
2090 * and checked by {@link #measure(int, int)} to determine if padding needs to be resolved
2091 * during measurement. In some special cases this is required such as when an adapter-based
2092 * view measures prospective children without attaching them to a window.
2093 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07002094 static final int PFLAG2_PADDING_RESOLVED = 0x20000000;
Adam Powell0090f202012-08-07 17:15:30 -07002095
Svetoslav Ganov27e2da72012-07-02 18:12:00 -07002096 // There are a couple of flags left in mPrivateFlags2
Svetoslav Ganovf9817f72012-05-22 18:10:31 -07002097
Christopher Tate3d4bf172011-03-28 16:16:46 -07002098 /* End of masks for mPrivateFlags2 */
2099
Chet Haase21433372012-06-05 07:54:09 -07002100 /* Masks for mPrivateFlags3 */
2101
2102 /**
2103 * Flag indicating that view has a transform animation set on it. This is used to track whether
2104 * an animation is cleared between successive frames, in order to tell the associated
2105 * DisplayList to clear its animation matrix.
2106 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07002107 static final int PFLAG3_VIEW_IS_ANIMATING_TRANSFORM = 0x1;
Chet Haase21433372012-06-05 07:54:09 -07002108
2109 /**
2110 * Flag indicating that view has an alpha animation set on it. This is used to track whether an
2111 * animation is cleared between successive frames, in order to tell the associated
2112 * DisplayList to restore its alpha value.
2113 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07002114 static final int PFLAG3_VIEW_IS_ANIMATING_ALPHA = 0x2;
Chet Haase21433372012-06-05 07:54:09 -07002115
2116
2117 /* End of masks for mPrivateFlags3 */
2118
Dianne Hackborn4702a852012-08-17 15:18:29 -07002119 static final int DRAG_MASK = PFLAG2_DRAG_CAN_ACCEPT | PFLAG2_DRAG_HOVERED;
Christopher Tate3d4bf172011-03-28 16:16:46 -07002120
Chet Haasedaf98e92011-01-10 14:10:36 -08002121 /**
Adam Powell637d3372010-08-25 14:37:03 -07002122 * Always allow a user to over-scroll this view, provided it is a
2123 * view that can scroll.
2124 *
2125 * @see #getOverScrollMode()
2126 * @see #setOverScrollMode(int)
2127 */
2128 public static final int OVER_SCROLL_ALWAYS = 0;
2129
2130 /**
2131 * Allow a user to over-scroll this view only if the content is large
2132 * enough to meaningfully scroll, provided it is a view that can scroll.
2133 *
2134 * @see #getOverScrollMode()
2135 * @see #setOverScrollMode(int)
2136 */
2137 public static final int OVER_SCROLL_IF_CONTENT_SCROLLS = 1;
2138
2139 /**
2140 * Never allow a user to over-scroll this view.
2141 *
2142 * @see #getOverScrollMode()
2143 * @see #setOverScrollMode(int)
2144 */
2145 public static final int OVER_SCROLL_NEVER = 2;
2146
2147 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002148 * Special constant for {@link #setSystemUiVisibility(int)}: View has
2149 * requested the system UI (status bar) to be visible (the default).
Joe Onorato664644d2011-01-23 17:53:23 -08002150 *
Joe Malin32736f02011-01-19 16:14:20 -08002151 * @see #setSystemUiVisibility(int)
Joe Onorato664644d2011-01-23 17:53:23 -08002152 */
Daniel Sandler60ee2562011-07-22 12:34:33 -04002153 public static final int SYSTEM_UI_FLAG_VISIBLE = 0;
Joe Onorato664644d2011-01-23 17:53:23 -08002154
2155 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002156 * Flag for {@link #setSystemUiVisibility(int)}: View has requested the
2157 * system UI to enter an unobtrusive "low profile" mode.
Daniel Sandler60ee2562011-07-22 12:34:33 -04002158 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002159 * <p>This is for use in games, book readers, video players, or any other
Philip Milne6c8ea062012-04-03 17:38:43 -07002160 * "immersive" application where the usual system chrome is deemed too distracting.
Daniel Sandler60ee2562011-07-22 12:34:33 -04002161 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002162 * <p>In low profile mode, the status bar and/or navigation icons may dim.
Joe Onorato664644d2011-01-23 17:53:23 -08002163 *
Joe Malin32736f02011-01-19 16:14:20 -08002164 * @see #setSystemUiVisibility(int)
Joe Onorato664644d2011-01-23 17:53:23 -08002165 */
Daniel Sandler60ee2562011-07-22 12:34:33 -04002166 public static final int SYSTEM_UI_FLAG_LOW_PROFILE = 0x00000001;
2167
2168 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002169 * Flag for {@link #setSystemUiVisibility(int)}: View has requested that the
2170 * system navigation be temporarily hidden.
Daniel Sandler60ee2562011-07-22 12:34:33 -04002171 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002172 * <p>This is an even less obtrusive state than that called for by
Daniel Sandler60ee2562011-07-22 12:34:33 -04002173 * {@link #SYSTEM_UI_FLAG_LOW_PROFILE}; on devices that draw essential navigation controls
2174 * (Home, Back, and the like) on screen, <code>SYSTEM_UI_FLAG_HIDE_NAVIGATION</code> will cause
2175 * those to disappear. This is useful (in conjunction with the
Philip Milne6c8ea062012-04-03 17:38:43 -07002176 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN FLAG_FULLSCREEN} and
Daniel Sandler60ee2562011-07-22 12:34:33 -04002177 * {@link android.view.WindowManager.LayoutParams#FLAG_LAYOUT_IN_SCREEN FLAG_LAYOUT_IN_SCREEN}
2178 * window flags) for displaying content using every last pixel on the display.
2179 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002180 * <p>There is a limitation: because navigation controls are so important, the least user
2181 * interaction will cause them to reappear immediately. When this happens, both
2182 * this flag and {@link #SYSTEM_UI_FLAG_FULLSCREEN} will be cleared automatically,
2183 * so that both elements reappear at the same time.
Daniel Sandler60ee2562011-07-22 12:34:33 -04002184 *
2185 * @see #setSystemUiVisibility(int)
2186 */
2187 public static final int SYSTEM_UI_FLAG_HIDE_NAVIGATION = 0x00000002;
2188
2189 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002190 * Flag for {@link #setSystemUiVisibility(int)}: View has requested to go
2191 * into the normal fullscreen mode so that its content can take over the screen
2192 * while still allowing the user to interact with the application.
2193 *
2194 * <p>This has the same visual effect as
2195 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN
2196 * WindowManager.LayoutParams.FLAG_FULLSCREEN},
2197 * meaning that non-critical screen decorations (such as the status bar) will be
2198 * hidden while the user is in the View's window, focusing the experience on
2199 * that content. Unlike the window flag, if you are using ActionBar in
2200 * overlay mode with {@link Window#FEATURE_ACTION_BAR_OVERLAY
2201 * Window.FEATURE_ACTION_BAR_OVERLAY}, then enabling this flag will also
2202 * hide the action bar.
2203 *
2204 * <p>This approach to going fullscreen is best used over the window flag when
2205 * it is a transient state -- that is, the application does this at certain
2206 * points in its user interaction where it wants to allow the user to focus
2207 * on content, but not as a continuous state. For situations where the application
2208 * would like to simply stay full screen the entire time (such as a game that
2209 * wants to take over the screen), the
2210 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN window flag}
2211 * is usually a better approach. The state set here will be removed by the system
2212 * in various situations (such as the user moving to another application) like
2213 * the other system UI states.
2214 *
2215 * <p>When using this flag, the application should provide some easy facility
2216 * for the user to go out of it. A common example would be in an e-book
2217 * reader, where tapping on the screen brings back whatever screen and UI
2218 * decorations that had been hidden while the user was immersed in reading
2219 * the book.
2220 *
2221 * @see #setSystemUiVisibility(int)
2222 */
2223 public static final int SYSTEM_UI_FLAG_FULLSCREEN = 0x00000004;
2224
2225 /**
2226 * Flag for {@link #setSystemUiVisibility(int)}: When using other layout
2227 * flags, we would like a stable view of the content insets given to
2228 * {@link #fitSystemWindows(Rect)}. This means that the insets seen there
2229 * will always represent the worst case that the application can expect
Dianne Hackborn5b5cc4d2012-05-16 13:15:00 -07002230 * as a continuous state. In the stock Android UI this is the space for
2231 * the system bar, nav bar, and status bar, but not more transient elements
2232 * such as an input method.
2233 *
2234 * The stable layout your UI sees is based on the system UI modes you can
2235 * switch to. That is, if you specify {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}
2236 * then you will get a stable layout for changes of the
2237 * {@link #SYSTEM_UI_FLAG_FULLSCREEN} mode; if you specify
2238 * {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN} and
2239 * {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}, then you can transition
2240 * to {@link #SYSTEM_UI_FLAG_FULLSCREEN} and {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}
2241 * with a stable layout. (Note that you should avoid using
2242 * {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION} by itself.)
2243 *
Jeff Smitha45746e2012-07-19 14:19:24 -05002244 * If you have set the window flag {@link WindowManager.LayoutParams#FLAG_FULLSCREEN}
Dianne Hackborn5b5cc4d2012-05-16 13:15:00 -07002245 * to hide the status bar (instead of using {@link #SYSTEM_UI_FLAG_FULLSCREEN}),
2246 * then a hidden status bar will be considered a "stable" state for purposes
2247 * here. This allows your UI to continually hide the status bar, while still
2248 * using the system UI flags to hide the action bar while still retaining
2249 * a stable layout. Note that changing the window fullscreen flag will never
2250 * provide a stable layout for a clean transition.
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002251 *
2252 * <p>If you are using ActionBar in
2253 * overlay mode with {@link Window#FEATURE_ACTION_BAR_OVERLAY
2254 * Window.FEATURE_ACTION_BAR_OVERLAY}, this flag will also impact the
2255 * insets it adds to those given to the application.
2256 */
2257 public static final int SYSTEM_UI_FLAG_LAYOUT_STABLE = 0x00000100;
2258
2259 /**
2260 * Flag for {@link #setSystemUiVisibility(int)}: View would like its window
2261 * to be layed out as if it has requested
2262 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, even if it currently hasn't. This
2263 * allows it to avoid artifacts when switching in and out of that mode, at
2264 * the expense that some of its user interface may be covered by screen
2265 * decorations when they are shown. You can perform layout of your inner
2266 * UI elements to account for the navagation system UI through the
2267 * {@link #fitSystemWindows(Rect)} method.
2268 */
2269 public static final int SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION = 0x00000200;
2270
2271 /**
2272 * Flag for {@link #setSystemUiVisibility(int)}: View would like its window
2273 * to be layed out as if it has requested
2274 * {@link #SYSTEM_UI_FLAG_FULLSCREEN}, even if it currently hasn't. This
2275 * allows it to avoid artifacts when switching in and out of that mode, at
2276 * the expense that some of its user interface may be covered by screen
2277 * decorations when they are shown. You can perform layout of your inner
2278 * UI elements to account for non-fullscreen system UI through the
2279 * {@link #fitSystemWindows(Rect)} method.
2280 */
2281 public static final int SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN = 0x00000400;
2282
2283 /**
Daniel Sandler60ee2562011-07-22 12:34:33 -04002284 * @deprecated Use {@link #SYSTEM_UI_FLAG_LOW_PROFILE} instead.
2285 */
2286 public static final int STATUS_BAR_HIDDEN = SYSTEM_UI_FLAG_LOW_PROFILE;
2287
2288 /**
2289 * @deprecated Use {@link #SYSTEM_UI_FLAG_VISIBLE} instead.
2290 */
2291 public static final int STATUS_BAR_VISIBLE = SYSTEM_UI_FLAG_VISIBLE;
Joe Onorato664644d2011-01-23 17:53:23 -08002292
2293 /**
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002294 * @hide
2295 *
2296 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2297 * out of the public fields to keep the undefined bits out of the developer's way.
2298 *
2299 * Flag to make the status bar not expandable. Unless you also
2300 * set {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS}, new notifications will continue to show.
2301 */
2302 public static final int STATUS_BAR_DISABLE_EXPAND = 0x00010000;
2303
2304 /**
2305 * @hide
2306 *
2307 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2308 * out of the public fields to keep the undefined bits out of the developer's way.
2309 *
2310 * Flag to hide notification icons and scrolling ticker text.
2311 */
2312 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ICONS = 0x00020000;
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 disable incoming notification alerts. This will not block
2321 * icons, but it will block sound, vibrating and other visual or aural notifications.
2322 */
2323 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ALERTS = 0x00040000;
2324
2325 /**
2326 * @hide
2327 *
2328 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2329 * out of the public fields to keep the undefined bits out of the developer's way.
2330 *
2331 * Flag to hide only the scrolling ticker. Note that
2332 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS} implies
2333 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_TICKER}.
2334 */
2335 public static final int STATUS_BAR_DISABLE_NOTIFICATION_TICKER = 0x00080000;
2336
2337 /**
2338 * @hide
2339 *
2340 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2341 * out of the public fields to keep the undefined bits out of the developer's way.
2342 *
2343 * Flag to hide the center system info area.
2344 */
2345 public static final int STATUS_BAR_DISABLE_SYSTEM_INFO = 0x00100000;
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 *
Daniel Sandlerdba93562011-10-06 16:39:58 -04002353 * Flag to hide only the home button. Don't use this
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002354 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
2355 */
Daniel Sandlerdba93562011-10-06 16:39:58 -04002356 public static final int STATUS_BAR_DISABLE_HOME = 0x00200000;
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002357
2358 /**
2359 * @hide
2360 *
2361 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2362 * out of the public fields to keep the undefined bits out of the developer's way.
2363 *
Daniel Sandlerdba93562011-10-06 16:39:58 -04002364 * Flag to hide only the back button. Don't use this
Joe Onorato6478adc2011-01-27 21:15:01 -08002365 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
2366 */
2367 public static final int STATUS_BAR_DISABLE_BACK = 0x00400000;
2368
2369 /**
2370 * @hide
2371 *
2372 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2373 * out of the public fields to keep the undefined bits out of the developer's way.
2374 *
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002375 * Flag to hide only the clock. You might use this if your activity has
2376 * its own clock making the status bar's clock redundant.
2377 */
Joe Onorato6478adc2011-01-27 21:15:01 -08002378 public static final int STATUS_BAR_DISABLE_CLOCK = 0x00800000;
2379
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002380 /**
2381 * @hide
Daniel Sandlerdba93562011-10-06 16:39:58 -04002382 *
2383 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2384 * out of the public fields to keep the undefined bits out of the developer's way.
2385 *
2386 * Flag to hide only the recent apps button. Don't use this
2387 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
2388 */
2389 public static final int STATUS_BAR_DISABLE_RECENT = 0x01000000;
2390
2391 /**
2392 * @hide
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002393 */
Daniel Sandler60ee2562011-07-22 12:34:33 -04002394 public static final int PUBLIC_STATUS_BAR_VISIBILITY_MASK = 0x0000FFFF;
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002395
2396 /**
Dianne Hackborn9a230e02011-10-06 11:51:27 -07002397 * These are the system UI flags that can be cleared by events outside
2398 * of an application. Currently this is just the ability to tap on the
2399 * screen while hiding the navigation bar to have it return.
2400 * @hide
2401 */
2402 public static final int SYSTEM_UI_CLEARABLE_FLAGS =
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002403 SYSTEM_UI_FLAG_LOW_PROFILE | SYSTEM_UI_FLAG_HIDE_NAVIGATION
2404 | SYSTEM_UI_FLAG_FULLSCREEN;
2405
2406 /**
2407 * Flags that can impact the layout in relation to system UI.
2408 */
2409 public static final int SYSTEM_UI_LAYOUT_FLAGS =
2410 SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION
2411 | SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN;
Dianne Hackborn9a230e02011-10-06 11:51:27 -07002412
2413 /**
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07002414 * Find views that render the specified text.
2415 *
2416 * @see #findViewsWithText(ArrayList, CharSequence, int)
2417 */
2418 public static final int FIND_VIEWS_WITH_TEXT = 0x00000001;
2419
2420 /**
2421 * Find find views that contain the specified content description.
2422 *
2423 * @see #findViewsWithText(ArrayList, CharSequence, int)
2424 */
2425 public static final int FIND_VIEWS_WITH_CONTENT_DESCRIPTION = 0x00000002;
2426
2427 /**
Svetoslav Ganov02107852011-10-03 17:06:56 -07002428 * Find views that contain {@link AccessibilityNodeProvider}. Such
2429 * a View is a root of virtual view hierarchy and may contain the searched
2430 * text. If this flag is set Views with providers are automatically
2431 * added and it is a responsibility of the client to call the APIs of
2432 * the provider to determine whether the virtual tree rooted at this View
2433 * contains the text, i.e. getting the list of {@link AccessibilityNodeInfo}s
2434 * represeting the virtual views with this text.
2435 *
2436 * @see #findViewsWithText(ArrayList, CharSequence, int)
2437 *
2438 * @hide
2439 */
2440 public static final int FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS = 0x00000004;
2441
2442 /**
Svetoslav Ganov39f2aee2012-05-29 09:15:30 -07002443 * The undefined cursor position.
2444 */
2445 private static final int ACCESSIBILITY_CURSOR_POSITION_UNDEFINED = -1;
2446
2447 /**
Romain Guybb9908b2012-03-08 11:14:07 -08002448 * Indicates that the screen has changed state and is now off.
2449 *
2450 * @see #onScreenStateChanged(int)
2451 */
2452 public static final int SCREEN_STATE_OFF = 0x0;
2453
2454 /**
2455 * Indicates that the screen has changed state and is now on.
2456 *
Romain Guy1e3d3132012-03-08 15:55:56 -08002457 * @see #onScreenStateChanged(int)
Romain Guybb9908b2012-03-08 11:14:07 -08002458 */
2459 public static final int SCREEN_STATE_ON = 0x1;
2460
2461 /**
Adam Powell637d3372010-08-25 14:37:03 -07002462 * Controls the over-scroll mode for this view.
2463 * See {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)},
2464 * {@link #OVER_SCROLL_ALWAYS}, {@link #OVER_SCROLL_IF_CONTENT_SCROLLS},
2465 * and {@link #OVER_SCROLL_NEVER}.
2466 */
2467 private int mOverScrollMode;
2468
2469 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002470 * The parent this view is attached to.
2471 * {@hide}
2472 *
2473 * @see #getParent()
2474 */
2475 protected ViewParent mParent;
2476
2477 /**
2478 * {@hide}
2479 */
2480 AttachInfo mAttachInfo;
2481
2482 /**
2483 * {@hide}
2484 */
Romain Guy809a7f62009-05-14 15:44:42 -07002485 @ViewDebug.ExportedProperty(flagMapping = {
Dianne Hackborn4702a852012-08-17 15:18:29 -07002486 @ViewDebug.FlagToString(mask = PFLAG_FORCE_LAYOUT, equals = PFLAG_FORCE_LAYOUT,
Romain Guy809a7f62009-05-14 15:44:42 -07002487 name = "FORCE_LAYOUT"),
Dianne Hackborn4702a852012-08-17 15:18:29 -07002488 @ViewDebug.FlagToString(mask = PFLAG_LAYOUT_REQUIRED, equals = PFLAG_LAYOUT_REQUIRED,
Romain Guy809a7f62009-05-14 15:44:42 -07002489 name = "LAYOUT_REQUIRED"),
Dianne Hackborn4702a852012-08-17 15:18:29 -07002490 @ViewDebug.FlagToString(mask = PFLAG_DRAWING_CACHE_VALID, equals = PFLAG_DRAWING_CACHE_VALID,
Romain Guy5bcdff42009-05-14 21:27:18 -07002491 name = "DRAWING_CACHE_INVALID", outputIf = false),
Dianne Hackborn4702a852012-08-17 15:18:29 -07002492 @ViewDebug.FlagToString(mask = PFLAG_DRAWN, equals = PFLAG_DRAWN, name = "DRAWN", outputIf = true),
2493 @ViewDebug.FlagToString(mask = PFLAG_DRAWN, equals = PFLAG_DRAWN, name = "NOT_DRAWN", outputIf = false),
2494 @ViewDebug.FlagToString(mask = PFLAG_DIRTY_MASK, equals = PFLAG_DIRTY_OPAQUE, name = "DIRTY_OPAQUE"),
2495 @ViewDebug.FlagToString(mask = PFLAG_DIRTY_MASK, equals = PFLAG_DIRTY, name = "DIRTY")
Romain Guy809a7f62009-05-14 15:44:42 -07002496 })
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002497 int mPrivateFlags;
Christopher Tate3d4bf172011-03-28 16:16:46 -07002498 int mPrivateFlags2;
Chet Haase21433372012-06-05 07:54:09 -07002499 int mPrivateFlags3;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002500
2501 /**
Joe Onorato664644d2011-01-23 17:53:23 -08002502 * This view's request for the visibility of the status bar.
2503 * @hide
2504 */
Daniel Sandler60ee2562011-07-22 12:34:33 -04002505 @ViewDebug.ExportedProperty(flagMapping = {
2506 @ViewDebug.FlagToString(mask = SYSTEM_UI_FLAG_LOW_PROFILE,
2507 equals = SYSTEM_UI_FLAG_LOW_PROFILE,
2508 name = "SYSTEM_UI_FLAG_LOW_PROFILE", outputIf = true),
2509 @ViewDebug.FlagToString(mask = SYSTEM_UI_FLAG_HIDE_NAVIGATION,
2510 equals = SYSTEM_UI_FLAG_HIDE_NAVIGATION,
2511 name = "SYSTEM_UI_FLAG_HIDE_NAVIGATION", outputIf = true),
2512 @ViewDebug.FlagToString(mask = PUBLIC_STATUS_BAR_VISIBILITY_MASK,
2513 equals = SYSTEM_UI_FLAG_VISIBLE,
2514 name = "SYSTEM_UI_FLAG_VISIBLE", outputIf = true)
2515 })
Joe Onorato664644d2011-01-23 17:53:23 -08002516 int mSystemUiVisibility;
2517
2518 /**
Chet Haase563d4f22012-04-18 16:20:08 -07002519 * Reference count for transient state.
2520 * @see #setHasTransientState(boolean)
2521 */
2522 int mTransientStateCount = 0;
2523
2524 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002525 * Count of how many windows this view has been attached to.
2526 */
2527 int mWindowAttachCount;
2528
2529 /**
2530 * The layout parameters associated with this view and used by the parent
2531 * {@link android.view.ViewGroup} to determine how this view should be
2532 * laid out.
2533 * {@hide}
2534 */
2535 protected ViewGroup.LayoutParams mLayoutParams;
2536
2537 /**
2538 * The view flags hold various views states.
2539 * {@hide}
2540 */
2541 @ViewDebug.ExportedProperty
2542 int mViewFlags;
2543
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002544 static class TransformationInfo {
2545 /**
2546 * The transform matrix for the View. This transform is calculated internally
2547 * based on the rotation, scaleX, and scaleY properties. The identity matrix
2548 * is used by default. Do *not* use this variable directly; instead call
2549 * getMatrix(), which will automatically recalculate the matrix if necessary
2550 * to get the correct matrix based on the latest rotation and scale properties.
2551 */
2552 private final Matrix mMatrix = new Matrix();
Chet Haasec3aa3612010-06-17 08:50:37 -07002553
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002554 /**
2555 * The transform matrix for the View. This transform is calculated internally
2556 * based on the rotation, scaleX, and scaleY properties. The identity matrix
2557 * is used by default. Do *not* use this variable directly; instead call
2558 * getInverseMatrix(), which will automatically recalculate the matrix if necessary
2559 * to get the correct matrix based on the latest rotation and scale properties.
2560 */
2561 private Matrix mInverseMatrix;
Chet Haasec3aa3612010-06-17 08:50:37 -07002562
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002563 /**
2564 * An internal variable that tracks whether we need to recalculate the
2565 * transform matrix, based on whether the rotation or scaleX/Y properties
2566 * have changed since the matrix was last calculated.
2567 */
2568 boolean mMatrixDirty = false;
Chet Haasec3aa3612010-06-17 08:50:37 -07002569
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002570 /**
2571 * An internal variable that tracks whether we need to recalculate the
2572 * transform matrix, based on whether the rotation or scaleX/Y properties
2573 * have changed since the matrix was last calculated.
2574 */
2575 private boolean mInverseMatrixDirty = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07002576
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002577 /**
2578 * A variable that tracks whether we need to recalculate the
2579 * transform matrix, based on whether the rotation or scaleX/Y properties
2580 * have changed since the matrix was last calculated. This variable
2581 * is only valid after a call to updateMatrix() or to a function that
2582 * calls it such as getMatrix(), hasIdentityMatrix() and getInverseMatrix().
2583 */
2584 private boolean mMatrixIsIdentity = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07002585
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002586 /**
2587 * The Camera object is used to compute a 3D matrix when rotationX or rotationY are set.
2588 */
2589 private Camera mCamera = null;
Chet Haasefd2b0022010-08-06 13:08:56 -07002590
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002591 /**
2592 * This matrix is used when computing the matrix for 3D rotations.
2593 */
2594 private Matrix matrix3D = null;
Chet Haasefd2b0022010-08-06 13:08:56 -07002595
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002596 /**
2597 * These prev values are used to recalculate a centered pivot point when necessary. The
2598 * pivot point is only used in matrix operations (when rotation, scale, or translation are
2599 * set), so thes values are only used then as well.
2600 */
2601 private int mPrevWidth = -1;
2602 private int mPrevHeight = -1;
Philip Milne6c8ea062012-04-03 17:38:43 -07002603
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002604 /**
2605 * The degrees rotation around the vertical axis through the pivot point.
2606 */
2607 @ViewDebug.ExportedProperty
2608 float mRotationY = 0f;
2609
2610 /**
2611 * The degrees rotation around the horizontal axis through the pivot point.
2612 */
2613 @ViewDebug.ExportedProperty
2614 float mRotationX = 0f;
2615
2616 /**
2617 * The degrees rotation around the pivot point.
2618 */
2619 @ViewDebug.ExportedProperty
2620 float mRotation = 0f;
2621
2622 /**
2623 * The amount of translation of the object away from its left property (post-layout).
2624 */
2625 @ViewDebug.ExportedProperty
2626 float mTranslationX = 0f;
2627
2628 /**
2629 * The amount of translation of the object away from its top property (post-layout).
2630 */
2631 @ViewDebug.ExportedProperty
2632 float mTranslationY = 0f;
2633
2634 /**
2635 * The amount of scale in the x direction around the pivot point. A
2636 * value of 1 means no scaling is applied.
2637 */
2638 @ViewDebug.ExportedProperty
2639 float mScaleX = 1f;
2640
2641 /**
2642 * The amount of scale in the y direction around the pivot point. A
2643 * value of 1 means no scaling is applied.
2644 */
2645 @ViewDebug.ExportedProperty
2646 float mScaleY = 1f;
2647
2648 /**
Chet Haasea33de552012-02-03 16:28:24 -08002649 * The x location of the point around which the view is rotated and scaled.
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002650 */
2651 @ViewDebug.ExportedProperty
2652 float mPivotX = 0f;
2653
2654 /**
Chet Haasea33de552012-02-03 16:28:24 -08002655 * The y location of the point around which the view is rotated and scaled.
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002656 */
2657 @ViewDebug.ExportedProperty
2658 float mPivotY = 0f;
2659
2660 /**
2661 * The opacity of the View. This is a value from 0 to 1, where 0 means
2662 * completely transparent and 1 means completely opaque.
2663 */
2664 @ViewDebug.ExportedProperty
2665 float mAlpha = 1f;
2666 }
2667
2668 TransformationInfo mTransformationInfo;
Chet Haasefd2b0022010-08-06 13:08:56 -07002669
Joe Malin32736f02011-01-19 16:14:20 -08002670 private boolean mLastIsOpaque;
2671
Chet Haasefd2b0022010-08-06 13:08:56 -07002672 /**
2673 * Convenience value to check for float values that are close enough to zero to be considered
2674 * zero.
2675 */
Romain Guy2542d192010-08-18 11:47:12 -07002676 private static final float NONZERO_EPSILON = .001f;
Chet Haasefd2b0022010-08-06 13:08:56 -07002677
2678 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002679 * The distance in pixels from the left edge of this view's parent
2680 * to the left edge of this view.
2681 * {@hide}
2682 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002683 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002684 protected int mLeft;
2685 /**
2686 * The distance in pixels from the left edge of this view's parent
2687 * to the right edge of this view.
2688 * {@hide}
2689 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002690 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002691 protected int mRight;
2692 /**
2693 * The distance in pixels from the top edge of this view's parent
2694 * to the top edge of this view.
2695 * {@hide}
2696 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002697 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002698 protected int mTop;
2699 /**
2700 * The distance in pixels from the top edge of this view's parent
2701 * to the bottom edge of this view.
2702 * {@hide}
2703 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002704 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002705 protected int mBottom;
2706
2707 /**
2708 * The offset, in pixels, by which the content of this view is scrolled
2709 * horizontally.
2710 * {@hide}
2711 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002712 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002713 protected int mScrollX;
2714 /**
2715 * The offset, in pixels, by which the content of this view is scrolled
2716 * vertically.
2717 * {@hide}
2718 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002719 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002720 protected int mScrollY;
2721
2722 /**
2723 * The left padding in pixels, that is the distance in pixels between the
2724 * left edge of this view and the left edge of its content.
2725 * {@hide}
2726 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002727 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002728 protected int mPaddingLeft;
2729 /**
2730 * The right padding in pixels, that is the distance in pixels between the
2731 * right edge of this view and the right edge of its content.
2732 * {@hide}
2733 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002734 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002735 protected int mPaddingRight;
2736 /**
2737 * The top padding in pixels, that is the distance in pixels between the
2738 * top edge of this view and the top edge of its content.
2739 * {@hide}
2740 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002741 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002742 protected int mPaddingTop;
2743 /**
2744 * The bottom padding in pixels, that is the distance in pixels between the
2745 * bottom edge of this view and the bottom edge of its content.
2746 * {@hide}
2747 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002748 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002749 protected int mPaddingBottom;
2750
2751 /**
Philip Milne1557fd72012-04-04 23:41:34 -07002752 * The layout insets in pixels, that is the distance in pixels between the
2753 * visible edges of this view its bounds.
2754 */
2755 private Insets mLayoutInsets;
2756
2757 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07002758 * Briefly describes the view and is primarily used for accessibility support.
2759 */
2760 private CharSequence mContentDescription;
2761
2762 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002763 * Cache the paddingRight set by the user to append to the scrollbar's size.
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002764 *
2765 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002766 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002767 @ViewDebug.ExportedProperty(category = "padding")
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002768 protected int mUserPaddingRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002769
2770 /**
2771 * Cache the paddingBottom set by the user to append to the scrollbar's size.
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002772 *
2773 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002774 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002775 @ViewDebug.ExportedProperty(category = "padding")
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002776 protected int mUserPaddingBottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002777
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002778 /**
Adam Powell20232d02010-12-08 21:08:53 -08002779 * Cache the paddingLeft set by the user to append to the scrollbar's size.
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002780 *
2781 * @hide
Adam Powell20232d02010-12-08 21:08:53 -08002782 */
2783 @ViewDebug.ExportedProperty(category = "padding")
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002784 protected int mUserPaddingLeft;
Adam Powell20232d02010-12-08 21:08:53 -08002785
2786 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07002787 * Cache the paddingStart set by the user to append to the scrollbar's size.
2788 *
2789 */
2790 @ViewDebug.ExportedProperty(category = "padding")
2791 int mUserPaddingStart;
2792
2793 /**
2794 * Cache the paddingEnd set by the user to append to the scrollbar's size.
2795 *
2796 */
2797 @ViewDebug.ExportedProperty(category = "padding")
2798 int mUserPaddingEnd;
2799
2800 /**
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07002801 * Whether a left padding has been defined during layout inflation.
2802 *
2803 * @hide
2804 */
2805 boolean mUserPaddingLeftDefined = false;
2806
2807 /**
2808 * Whether a right padding has been defined during layout inflation.
2809 *
2810 * @hide
2811 */
2812 boolean mUserPaddingRightDefined = false;
2813
2814 /**
Fabrice Di Meglio016456e2012-07-17 20:35:48 -07002815 * Default undefined padding
2816 */
2817 private static final int UNDEFINED_PADDING = Integer.MIN_VALUE;
2818
2819 /**
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002820 * @hide
2821 */
2822 int mOldWidthMeasureSpec = Integer.MIN_VALUE;
2823 /**
2824 * @hide
2825 */
2826 int mOldHeightMeasureSpec = Integer.MIN_VALUE;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002827
Philip Milne6c8ea062012-04-03 17:38:43 -07002828 private Drawable mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002829
2830 private int mBackgroundResource;
2831 private boolean mBackgroundSizeChanged;
2832
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002833 static class ListenerInfo {
2834 /**
2835 * Listener used to dispatch focus change events.
2836 * This field should be made private, so it is hidden from the SDK.
2837 * {@hide}
2838 */
2839 protected OnFocusChangeListener mOnFocusChangeListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002840
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002841 /**
2842 * Listeners for layout change events.
2843 */
2844 private ArrayList<OnLayoutChangeListener> mOnLayoutChangeListeners;
Chet Haase21cd1382010-09-01 17:42:29 -07002845
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002846 /**
2847 * Listeners for attach events.
2848 */
2849 private CopyOnWriteArrayList<OnAttachStateChangeListener> mOnAttachStateChangeListeners;
Adam Powell4afd62b2011-02-18 15:02:18 -08002850
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002851 /**
2852 * Listener used to dispatch click events.
2853 * This field should be made private, so it is hidden from the SDK.
2854 * {@hide}
2855 */
2856 public OnClickListener mOnClickListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002857
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002858 /**
2859 * Listener used to dispatch long click events.
2860 * This field should be made private, so it is hidden from the SDK.
2861 * {@hide}
2862 */
2863 protected OnLongClickListener mOnLongClickListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002864
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002865 /**
2866 * Listener used to build the context menu.
2867 * This field should be made private, so it is hidden from the SDK.
2868 * {@hide}
2869 */
2870 protected OnCreateContextMenuListener mOnCreateContextMenuListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002871
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002872 private OnKeyListener mOnKeyListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002873
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002874 private OnTouchListener mOnTouchListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002875
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002876 private OnHoverListener mOnHoverListener;
Jeff Brown10b62902011-06-20 16:40:37 -07002877
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002878 private OnGenericMotionListener mOnGenericMotionListener;
Jeff Brown33bbfd22011-02-24 20:55:35 -08002879
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002880 private OnDragListener mOnDragListener;
Chris Tate32affef2010-10-18 15:29:21 -07002881
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002882 private OnSystemUiVisibilityChangeListener mOnSystemUiVisibilityChangeListener;
2883 }
2884
2885 ListenerInfo mListenerInfo;
Joe Onorato664644d2011-01-23 17:53:23 -08002886
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002887 /**
2888 * The application environment this view lives in.
2889 * This field should be made private, so it is hidden from the SDK.
2890 * {@hide}
2891 */
2892 protected Context mContext;
2893
Dianne Hackbornab0f4852011-09-12 16:59:06 -07002894 private final Resources mResources;
2895
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002896 private ScrollabilityCache mScrollCache;
2897
2898 private int[] mDrawableState = null;
2899
Romain Guy0211a0a2011-02-14 16:34:59 -08002900 /**
2901 * Set to true when drawing cache is enabled and cannot be created.
Philip Milne6c8ea062012-04-03 17:38:43 -07002902 *
Romain Guy0211a0a2011-02-14 16:34:59 -08002903 * @hide
2904 */
2905 public boolean mCachingFailed;
2906
Romain Guy02890fd2010-08-06 17:58:44 -07002907 private Bitmap mDrawingCache;
2908 private Bitmap mUnscaledDrawingCache;
Romain Guy6c319ca2011-01-11 14:29:25 -08002909 private HardwareLayer mHardwareLayer;
Romain Guy65b345f2011-07-27 18:51:50 -07002910 DisplayList mDisplayList;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002911
2912 /**
2913 * When this view has focus and the next focus is {@link #FOCUS_LEFT},
2914 * the user may specify which view to go to next.
2915 */
2916 private int mNextFocusLeftId = View.NO_ID;
2917
2918 /**
2919 * When this view has focus and the next focus is {@link #FOCUS_RIGHT},
2920 * the user may specify which view to go to next.
2921 */
2922 private int mNextFocusRightId = View.NO_ID;
2923
2924 /**
2925 * When this view has focus and the next focus is {@link #FOCUS_UP},
2926 * the user may specify which view to go to next.
2927 */
2928 private int mNextFocusUpId = View.NO_ID;
2929
2930 /**
2931 * When this view has focus and the next focus is {@link #FOCUS_DOWN},
2932 * the user may specify which view to go to next.
2933 */
2934 private int mNextFocusDownId = View.NO_ID;
2935
Jeff Brown4e6319b2010-12-13 10:36:51 -08002936 /**
2937 * When this view has focus and the next focus is {@link #FOCUS_FORWARD},
2938 * the user may specify which view to go to next.
2939 */
2940 int mNextFocusForwardId = View.NO_ID;
2941
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002942 private CheckForLongPress mPendingCheckForLongPress;
Adam Powelle14579b2009-12-16 18:39:52 -08002943 private CheckForTap mPendingCheckForTap = null;
Adam Powella35d7682010-03-12 14:48:13 -08002944 private PerformClick mPerformClick;
Svetoslav Ganova0156172011-06-26 17:55:44 -07002945 private SendViewScrolledAccessibilityEvent mSendViewScrolledAccessibilityEvent;
Joe Malin32736f02011-01-19 16:14:20 -08002946
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002947 private UnsetPressedState mUnsetPressedState;
2948
2949 /**
2950 * Whether the long press's action has been invoked. The tap's action is invoked on the
2951 * up event while a long press is invoked as soon as the long press duration is reached, so
2952 * a long press could be performed before the tap is checked, in which case the tap's action
2953 * should not be invoked.
2954 */
2955 private boolean mHasPerformedLongPress;
2956
2957 /**
2958 * The minimum height of the view. We'll try our best to have the height
2959 * of this view to at least this amount.
2960 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002961 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002962 private int mMinHeight;
2963
2964 /**
2965 * The minimum width of the view. We'll try our best to have the width
2966 * of this view to at least this amount.
2967 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002968 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002969 private int mMinWidth;
2970
2971 /**
2972 * The delegate to handle touch events that are physically in this view
2973 * but should be handled by another view.
2974 */
2975 private TouchDelegate mTouchDelegate = null;
2976
2977 /**
2978 * Solid color to use as a background when creating the drawing cache. Enables
2979 * the cache to use 16 bit bitmaps instead of 32 bit.
2980 */
2981 private int mDrawingCacheBackgroundColor = 0;
2982
2983 /**
2984 * Special tree observer used when mAttachInfo is null.
2985 */
2986 private ViewTreeObserver mFloatingTreeObserver;
Joe Malin32736f02011-01-19 16:14:20 -08002987
Adam Powelle14579b2009-12-16 18:39:52 -08002988 /**
2989 * Cache the touch slop from the context that created the view.
2990 */
2991 private int mTouchSlop;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002992
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002993 /**
Chet Haasea00f3862011-02-22 06:34:40 -08002994 * Object that handles automatic animation of view properties.
2995 */
2996 private ViewPropertyAnimator mAnimator = null;
2997
2998 /**
Christopher Tate251602f2011-01-28 17:54:12 -08002999 * Flag indicating that a drag can cross window boundaries. When
3000 * {@link #startDrag(ClipData, DragShadowBuilder, Object, int)} is called
3001 * with this flag set, all visible applications will be able to participate
3002 * in the drag operation and receive the dragged content.
Christopher Tate7f9ff9d2011-02-14 17:31:13 -08003003 *
3004 * @hide
Christopher Tate02d2b3b2011-01-10 20:43:53 -08003005 */
3006 public static final int DRAG_FLAG_GLOBAL = 1;
3007
3008 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08003009 * Vertical scroll factor cached by {@link #getVerticalScrollFactor}.
3010 */
3011 private float mVerticalScrollFactor;
3012
3013 /**
Adam Powell20232d02010-12-08 21:08:53 -08003014 * Position of the vertical scroll bar.
3015 */
3016 private int mVerticalScrollbarPosition;
3017
3018 /**
3019 * Position the scroll bar at the default position as determined by the system.
3020 */
3021 public static final int SCROLLBAR_POSITION_DEFAULT = 0;
3022
3023 /**
3024 * Position the scroll bar along the left edge.
3025 */
3026 public static final int SCROLLBAR_POSITION_LEFT = 1;
3027
3028 /**
3029 * Position the scroll bar along the right edge.
3030 */
3031 public static final int SCROLLBAR_POSITION_RIGHT = 2;
3032
3033 /**
Romain Guy171c5922011-01-06 10:04:23 -08003034 * Indicates that the view does not have a layer.
Joe Malin32736f02011-01-19 16:14:20 -08003035 *
3036 * @see #getLayerType()
3037 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy171c5922011-01-06 10:04:23 -08003038 * @see #LAYER_TYPE_SOFTWARE
Joe Malin32736f02011-01-19 16:14:20 -08003039 * @see #LAYER_TYPE_HARDWARE
Romain Guy171c5922011-01-06 10:04:23 -08003040 */
3041 public static final int LAYER_TYPE_NONE = 0;
3042
3043 /**
3044 * <p>Indicates that the view has a software layer. A software layer is backed
3045 * by a bitmap and causes the view to be rendered using Android's software
3046 * rendering pipeline, even if hardware acceleration is enabled.</p>
Joe Malin32736f02011-01-19 16:14:20 -08003047 *
Romain Guy171c5922011-01-06 10:04:23 -08003048 * <p>Software layers have various usages:</p>
3049 * <p>When the application is not using hardware acceleration, a software layer
3050 * is useful to apply a specific color filter and/or blending mode and/or
3051 * translucency to a view and all its children.</p>
3052 * <p>When the application is using hardware acceleration, a software layer
3053 * is useful to render drawing primitives not supported by the hardware
3054 * accelerated pipeline. It can also be used to cache a complex view tree
3055 * into a texture and reduce the complexity of drawing operations. For instance,
3056 * when animating a complex view tree with a translation, a software layer can
3057 * be used to render the view tree only once.</p>
3058 * <p>Software layers should be avoided when the affected view tree updates
3059 * often. Every update will require to re-render the software layer, which can
3060 * potentially be slow (particularly when hardware acceleration is turned on
3061 * since the layer will have to be uploaded into a hardware texture after every
3062 * update.)</p>
Joe Malin32736f02011-01-19 16:14:20 -08003063 *
3064 * @see #getLayerType()
3065 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy171c5922011-01-06 10:04:23 -08003066 * @see #LAYER_TYPE_NONE
Joe Malin32736f02011-01-19 16:14:20 -08003067 * @see #LAYER_TYPE_HARDWARE
Romain Guy171c5922011-01-06 10:04:23 -08003068 */
3069 public static final int LAYER_TYPE_SOFTWARE = 1;
3070
3071 /**
3072 * <p>Indicates that the view has a hardware layer. A hardware layer is backed
3073 * by a hardware specific texture (generally Frame Buffer Objects or FBO on
3074 * OpenGL hardware) and causes the view to be rendered using Android's hardware
3075 * rendering pipeline, but only if hardware acceleration is turned on for the
3076 * view hierarchy. When hardware acceleration is turned off, hardware layers
3077 * behave exactly as {@link #LAYER_TYPE_SOFTWARE software layers}.</p>
Joe Malin32736f02011-01-19 16:14:20 -08003078 *
Romain Guy171c5922011-01-06 10:04:23 -08003079 * <p>A hardware layer is useful to apply a specific color filter and/or
3080 * blending mode and/or translucency to a view and all its children.</p>
Romain Guy6c319ca2011-01-11 14:29:25 -08003081 * <p>A hardware layer can be used to cache a complex view tree into a
3082 * texture and reduce the complexity of drawing operations. For instance,
3083 * when animating a complex view tree with a translation, a hardware layer can
3084 * be used to render the view tree only once.</p>
Romain Guy171c5922011-01-06 10:04:23 -08003085 * <p>A hardware layer can also be used to increase the rendering quality when
3086 * rotation transformations are applied on a view. It can also be used to
3087 * prevent potential clipping issues when applying 3D transforms on a view.</p>
Joe Malin32736f02011-01-19 16:14:20 -08003088 *
3089 * @see #getLayerType()
Romain Guy171c5922011-01-06 10:04:23 -08003090 * @see #setLayerType(int, android.graphics.Paint)
3091 * @see #LAYER_TYPE_NONE
3092 * @see #LAYER_TYPE_SOFTWARE
3093 */
3094 public static final int LAYER_TYPE_HARDWARE = 2;
Joe Malin32736f02011-01-19 16:14:20 -08003095
Romain Guy3aaff3a2011-01-12 14:18:47 -08003096 @ViewDebug.ExportedProperty(category = "drawing", mapping = {
3097 @ViewDebug.IntToString(from = LAYER_TYPE_NONE, to = "NONE"),
3098 @ViewDebug.IntToString(from = LAYER_TYPE_SOFTWARE, to = "SOFTWARE"),
3099 @ViewDebug.IntToString(from = LAYER_TYPE_HARDWARE, to = "HARDWARE")
3100 })
Romain Guy171c5922011-01-06 10:04:23 -08003101 int mLayerType = LAYER_TYPE_NONE;
3102 Paint mLayerPaint;
Romain Guy3a3133d2011-02-01 22:59:58 -08003103 Rect mLocalDirtyRect;
Romain Guy171c5922011-01-06 10:04:23 -08003104
3105 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07003106 * Set to true when the view is sending hover accessibility events because it
3107 * is the innermost hovered view.
3108 */
3109 private boolean mSendingHoverAccessibilityEvents;
3110
Dianne Hackborn4702a852012-08-17 15:18:29 -07003111 /**
3112 * Delegate for injecting accessiblity functionality.
3113 */
3114 AccessibilityDelegate mAccessibilityDelegate;
3115
3116 /**
3117 * Consistency verifier for debugging purposes.
3118 * @hide
3119 */
3120 protected final InputEventConsistencyVerifier mInputEventConsistencyVerifier =
3121 InputEventConsistencyVerifier.isInstrumentationEnabled() ?
3122 new InputEventConsistencyVerifier(this, 0) : null;
3123
Adam Powella9108a22012-07-18 11:18:09 -07003124 private static final AtomicInteger sNextGeneratedId = new AtomicInteger(1);
3125
Jeff Brown87b7f802011-06-21 18:35:45 -07003126 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003127 * Simple constructor to use when creating a view from code.
3128 *
3129 * @param context The Context the view is running in, through which it can
3130 * access the current theme, resources, etc.
3131 */
3132 public View(Context context) {
3133 mContext = context;
3134 mResources = context != null ? context.getResources() : null;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07003135 mViewFlags = SOUND_EFFECTS_ENABLED | HAPTIC_FEEDBACK_ENABLED;
Fabrice Di Megliob934db72012-03-20 14:33:01 -07003136 // Set layout and text direction defaults
Dianne Hackborn4702a852012-08-17 15:18:29 -07003137 mPrivateFlags2 = (LAYOUT_DIRECTION_DEFAULT << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT) |
3138 (TEXT_DIRECTION_DEFAULT << PFLAG2_TEXT_DIRECTION_MASK_SHIFT) |
3139 (TEXT_ALIGNMENT_DEFAULT << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT) |
3140 (IMPORTANT_FOR_ACCESSIBILITY_DEFAULT << PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT);
Adam Powelle14579b2009-12-16 18:39:52 -08003141 mTouchSlop = ViewConfiguration.get(context).getScaledTouchSlop();
Adam Powell637d3372010-08-25 14:37:03 -07003142 setOverScrollMode(OVER_SCROLL_IF_CONTENT_SCROLLS);
Fabrice Di Meglio016456e2012-07-17 20:35:48 -07003143 mUserPaddingStart = UNDEFINED_PADDING;
3144 mUserPaddingEnd = UNDEFINED_PADDING;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003145 }
3146
3147 /**
3148 * Constructor that is called when inflating a view from XML. This is called
3149 * when a view is being constructed from an XML file, supplying attributes
3150 * that were specified in the XML file. This version uses a default style of
3151 * 0, so the only attribute values applied are those in the Context's Theme
3152 * and the given AttributeSet.
3153 *
3154 * <p>
3155 * The method onFinishInflate() will be called after all children have been
3156 * added.
3157 *
3158 * @param context The Context the view is running in, through which it can
3159 * access the current theme, resources, etc.
3160 * @param attrs The attributes of the XML tag that is inflating the view.
3161 * @see #View(Context, AttributeSet, int)
3162 */
3163 public View(Context context, AttributeSet attrs) {
3164 this(context, attrs, 0);
3165 }
3166
3167 /**
3168 * Perform inflation from XML and apply a class-specific base style. This
3169 * constructor of View allows subclasses to use their own base style when
3170 * they are inflating. For example, a Button class's constructor would call
3171 * this version of the super class constructor and supply
3172 * <code>R.attr.buttonStyle</code> for <var>defStyle</var>; this allows
3173 * the theme's button style to modify all of the base view attributes (in
3174 * particular its background) as well as the Button class's attributes.
3175 *
3176 * @param context The Context the view is running in, through which it can
3177 * access the current theme, resources, etc.
3178 * @param attrs The attributes of the XML tag that is inflating the view.
3179 * @param defStyle The default style to apply to this view. If 0, no style
3180 * will be applied (beyond what is included in the theme). This may
3181 * either be an attribute resource, whose value will be retrieved
3182 * from the current theme, or an explicit style resource.
3183 * @see #View(Context, AttributeSet)
3184 */
3185 public View(Context context, AttributeSet attrs, int defStyle) {
3186 this(context);
3187
3188 TypedArray a = context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.View,
3189 defStyle, 0);
3190
3191 Drawable background = null;
3192
3193 int leftPadding = -1;
3194 int topPadding = -1;
3195 int rightPadding = -1;
3196 int bottomPadding = -1;
Fabrice Di Meglio016456e2012-07-17 20:35:48 -07003197 int startPadding = UNDEFINED_PADDING;
3198 int endPadding = UNDEFINED_PADDING;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003199
3200 int padding = -1;
3201
3202 int viewFlagValues = 0;
3203 int viewFlagMasks = 0;
3204
3205 boolean setScrollContainer = false;
Romain Guy8506ab42009-06-11 17:35:47 -07003206
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003207 int x = 0;
3208 int y = 0;
3209
Chet Haase73066682010-11-29 15:55:32 -08003210 float tx = 0;
3211 float ty = 0;
3212 float rotation = 0;
3213 float rotationX = 0;
3214 float rotationY = 0;
3215 float sx = 1f;
3216 float sy = 1f;
3217 boolean transformSet = false;
3218
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003219 int scrollbarStyle = SCROLLBARS_INSIDE_OVERLAY;
Adam Powell637d3372010-08-25 14:37:03 -07003220 int overScrollMode = mOverScrollMode;
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07003221 boolean initializeScrollbars = false;
3222
3223 final int targetSdkVersion = context.getApplicationInfo().targetSdkVersion;
3224
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003225 final int N = a.getIndexCount();
3226 for (int i = 0; i < N; i++) {
3227 int attr = a.getIndex(i);
3228 switch (attr) {
3229 case com.android.internal.R.styleable.View_background:
3230 background = a.getDrawable(attr);
3231 break;
3232 case com.android.internal.R.styleable.View_padding:
3233 padding = a.getDimensionPixelSize(attr, -1);
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07003234 mUserPaddingLeftDefined = true;
3235 mUserPaddingRightDefined = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003236 break;
3237 case com.android.internal.R.styleable.View_paddingLeft:
3238 leftPadding = a.getDimensionPixelSize(attr, -1);
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07003239 mUserPaddingLeftDefined = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003240 break;
3241 case com.android.internal.R.styleable.View_paddingTop:
3242 topPadding = a.getDimensionPixelSize(attr, -1);
3243 break;
3244 case com.android.internal.R.styleable.View_paddingRight:
3245 rightPadding = a.getDimensionPixelSize(attr, -1);
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07003246 mUserPaddingRightDefined = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003247 break;
3248 case com.android.internal.R.styleable.View_paddingBottom:
3249 bottomPadding = a.getDimensionPixelSize(attr, -1);
3250 break;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003251 case com.android.internal.R.styleable.View_paddingStart:
Fabrice Di Meglio016456e2012-07-17 20:35:48 -07003252 startPadding = a.getDimensionPixelSize(attr, UNDEFINED_PADDING);
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003253 break;
3254 case com.android.internal.R.styleable.View_paddingEnd:
Fabrice Di Meglio016456e2012-07-17 20:35:48 -07003255 endPadding = a.getDimensionPixelSize(attr, UNDEFINED_PADDING);
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003256 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003257 case com.android.internal.R.styleable.View_scrollX:
3258 x = a.getDimensionPixelOffset(attr, 0);
3259 break;
3260 case com.android.internal.R.styleable.View_scrollY:
3261 y = a.getDimensionPixelOffset(attr, 0);
3262 break;
Chet Haase73066682010-11-29 15:55:32 -08003263 case com.android.internal.R.styleable.View_alpha:
3264 setAlpha(a.getFloat(attr, 1f));
3265 break;
3266 case com.android.internal.R.styleable.View_transformPivotX:
3267 setPivotX(a.getDimensionPixelOffset(attr, 0));
3268 break;
3269 case com.android.internal.R.styleable.View_transformPivotY:
3270 setPivotY(a.getDimensionPixelOffset(attr, 0));
3271 break;
3272 case com.android.internal.R.styleable.View_translationX:
3273 tx = a.getDimensionPixelOffset(attr, 0);
3274 transformSet = true;
3275 break;
3276 case com.android.internal.R.styleable.View_translationY:
3277 ty = a.getDimensionPixelOffset(attr, 0);
3278 transformSet = true;
3279 break;
3280 case com.android.internal.R.styleable.View_rotation:
3281 rotation = a.getFloat(attr, 0);
3282 transformSet = true;
3283 break;
3284 case com.android.internal.R.styleable.View_rotationX:
3285 rotationX = a.getFloat(attr, 0);
3286 transformSet = true;
3287 break;
3288 case com.android.internal.R.styleable.View_rotationY:
3289 rotationY = a.getFloat(attr, 0);
3290 transformSet = true;
3291 break;
3292 case com.android.internal.R.styleable.View_scaleX:
3293 sx = a.getFloat(attr, 1f);
3294 transformSet = true;
3295 break;
3296 case com.android.internal.R.styleable.View_scaleY:
3297 sy = a.getFloat(attr, 1f);
3298 transformSet = true;
3299 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003300 case com.android.internal.R.styleable.View_id:
3301 mID = a.getResourceId(attr, NO_ID);
3302 break;
3303 case com.android.internal.R.styleable.View_tag:
3304 mTag = a.getText(attr);
3305 break;
3306 case com.android.internal.R.styleable.View_fitsSystemWindows:
3307 if (a.getBoolean(attr, false)) {
3308 viewFlagValues |= FITS_SYSTEM_WINDOWS;
3309 viewFlagMasks |= FITS_SYSTEM_WINDOWS;
3310 }
3311 break;
3312 case com.android.internal.R.styleable.View_focusable:
3313 if (a.getBoolean(attr, false)) {
3314 viewFlagValues |= FOCUSABLE;
3315 viewFlagMasks |= FOCUSABLE_MASK;
3316 }
3317 break;
3318 case com.android.internal.R.styleable.View_focusableInTouchMode:
3319 if (a.getBoolean(attr, false)) {
3320 viewFlagValues |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE;
3321 viewFlagMasks |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE_MASK;
3322 }
3323 break;
3324 case com.android.internal.R.styleable.View_clickable:
3325 if (a.getBoolean(attr, false)) {
3326 viewFlagValues |= CLICKABLE;
3327 viewFlagMasks |= CLICKABLE;
3328 }
3329 break;
3330 case com.android.internal.R.styleable.View_longClickable:
3331 if (a.getBoolean(attr, false)) {
3332 viewFlagValues |= LONG_CLICKABLE;
3333 viewFlagMasks |= LONG_CLICKABLE;
3334 }
3335 break;
3336 case com.android.internal.R.styleable.View_saveEnabled:
3337 if (!a.getBoolean(attr, true)) {
3338 viewFlagValues |= SAVE_DISABLED;
3339 viewFlagMasks |= SAVE_DISABLED_MASK;
3340 }
3341 break;
3342 case com.android.internal.R.styleable.View_duplicateParentState:
3343 if (a.getBoolean(attr, false)) {
3344 viewFlagValues |= DUPLICATE_PARENT_STATE;
3345 viewFlagMasks |= DUPLICATE_PARENT_STATE;
3346 }
3347 break;
3348 case com.android.internal.R.styleable.View_visibility:
3349 final int visibility = a.getInt(attr, 0);
3350 if (visibility != 0) {
3351 viewFlagValues |= VISIBILITY_FLAGS[visibility];
3352 viewFlagMasks |= VISIBILITY_MASK;
3353 }
3354 break;
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07003355 case com.android.internal.R.styleable.View_layoutDirection:
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07003356 // Clear any layout direction flags (included resolved bits) already set
Dianne Hackborn4702a852012-08-17 15:18:29 -07003357 mPrivateFlags2 &= ~(PFLAG2_LAYOUT_DIRECTION_MASK | PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK);
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07003358 // Set the layout direction flags depending on the value of the attribute
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07003359 final int layoutDirection = a.getInt(attr, -1);
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07003360 final int value = (layoutDirection != -1) ?
3361 LAYOUT_DIRECTION_FLAGS[layoutDirection] : LAYOUT_DIRECTION_DEFAULT;
Dianne Hackborn4702a852012-08-17 15:18:29 -07003362 mPrivateFlags2 |= (value << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT);
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07003363 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003364 case com.android.internal.R.styleable.View_drawingCacheQuality:
3365 final int cacheQuality = a.getInt(attr, 0);
3366 if (cacheQuality != 0) {
3367 viewFlagValues |= DRAWING_CACHE_QUALITY_FLAGS[cacheQuality];
3368 viewFlagMasks |= DRAWING_CACHE_QUALITY_MASK;
3369 }
3370 break;
svetoslavganov75986cf2009-05-14 22:28:01 -07003371 case com.android.internal.R.styleable.View_contentDescription:
Svetoslav Ganove47957a2012-06-05 14:46:50 -07003372 setContentDescription(a.getString(attr));
svetoslavganov75986cf2009-05-14 22:28:01 -07003373 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003374 case com.android.internal.R.styleable.View_soundEffectsEnabled:
3375 if (!a.getBoolean(attr, true)) {
3376 viewFlagValues &= ~SOUND_EFFECTS_ENABLED;
3377 viewFlagMasks |= SOUND_EFFECTS_ENABLED;
3378 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07003379 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003380 case com.android.internal.R.styleable.View_hapticFeedbackEnabled:
3381 if (!a.getBoolean(attr, true)) {
3382 viewFlagValues &= ~HAPTIC_FEEDBACK_ENABLED;
3383 viewFlagMasks |= HAPTIC_FEEDBACK_ENABLED;
3384 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07003385 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003386 case R.styleable.View_scrollbars:
3387 final int scrollbars = a.getInt(attr, SCROLLBARS_NONE);
3388 if (scrollbars != SCROLLBARS_NONE) {
3389 viewFlagValues |= scrollbars;
3390 viewFlagMasks |= SCROLLBARS_MASK;
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07003391 initializeScrollbars = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003392 }
3393 break;
Romain Guy2a9fa892011-09-28 16:50:02 -07003394 //noinspection deprecation
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003395 case R.styleable.View_fadingEdge:
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07003396 if (targetSdkVersion >= ICE_CREAM_SANDWICH) {
Romain Guy1ef3fdb2011-09-09 15:30:30 -07003397 // Ignore the attribute starting with ICS
3398 break;
3399 }
3400 // With builds < ICS, fall through and apply fading edges
3401 case R.styleable.View_requiresFadingEdge:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003402 final int fadingEdge = a.getInt(attr, FADING_EDGE_NONE);
3403 if (fadingEdge != FADING_EDGE_NONE) {
3404 viewFlagValues |= fadingEdge;
3405 viewFlagMasks |= FADING_EDGE_MASK;
3406 initializeFadingEdge(a);
3407 }
3408 break;
3409 case R.styleable.View_scrollbarStyle:
3410 scrollbarStyle = a.getInt(attr, SCROLLBARS_INSIDE_OVERLAY);
3411 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
3412 viewFlagValues |= scrollbarStyle & SCROLLBARS_STYLE_MASK;
3413 viewFlagMasks |= SCROLLBARS_STYLE_MASK;
3414 }
3415 break;
3416 case R.styleable.View_isScrollContainer:
3417 setScrollContainer = true;
3418 if (a.getBoolean(attr, false)) {
3419 setScrollContainer(true);
3420 }
3421 break;
3422 case com.android.internal.R.styleable.View_keepScreenOn:
3423 if (a.getBoolean(attr, false)) {
3424 viewFlagValues |= KEEP_SCREEN_ON;
3425 viewFlagMasks |= KEEP_SCREEN_ON;
3426 }
3427 break;
Jeff Brown85a31762010-09-01 17:01:00 -07003428 case R.styleable.View_filterTouchesWhenObscured:
3429 if (a.getBoolean(attr, false)) {
3430 viewFlagValues |= FILTER_TOUCHES_WHEN_OBSCURED;
3431 viewFlagMasks |= FILTER_TOUCHES_WHEN_OBSCURED;
3432 }
3433 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003434 case R.styleable.View_nextFocusLeft:
3435 mNextFocusLeftId = a.getResourceId(attr, View.NO_ID);
3436 break;
3437 case R.styleable.View_nextFocusRight:
3438 mNextFocusRightId = a.getResourceId(attr, View.NO_ID);
3439 break;
3440 case R.styleable.View_nextFocusUp:
3441 mNextFocusUpId = a.getResourceId(attr, View.NO_ID);
3442 break;
3443 case R.styleable.View_nextFocusDown:
3444 mNextFocusDownId = a.getResourceId(attr, View.NO_ID);
3445 break;
Jeff Brown4e6319b2010-12-13 10:36:51 -08003446 case R.styleable.View_nextFocusForward:
3447 mNextFocusForwardId = a.getResourceId(attr, View.NO_ID);
3448 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003449 case R.styleable.View_minWidth:
3450 mMinWidth = a.getDimensionPixelSize(attr, 0);
3451 break;
3452 case R.styleable.View_minHeight:
3453 mMinHeight = a.getDimensionPixelSize(attr, 0);
3454 break;
Romain Guy9a817362009-05-01 10:57:14 -07003455 case R.styleable.View_onClick:
Romain Guy870e09f2009-07-06 16:35:25 -07003456 if (context.isRestricted()) {
Joe Malin32736f02011-01-19 16:14:20 -08003457 throw new IllegalStateException("The android:onClick attribute cannot "
Romain Guy870e09f2009-07-06 16:35:25 -07003458 + "be used within a restricted context");
3459 }
3460
Romain Guy9a817362009-05-01 10:57:14 -07003461 final String handlerName = a.getString(attr);
3462 if (handlerName != null) {
3463 setOnClickListener(new OnClickListener() {
3464 private Method mHandler;
3465
3466 public void onClick(View v) {
3467 if (mHandler == null) {
3468 try {
3469 mHandler = getContext().getClass().getMethod(handlerName,
3470 View.class);
3471 } catch (NoSuchMethodException e) {
Joe Onorato42e14d72010-03-11 14:51:17 -08003472 int id = getId();
3473 String idText = id == NO_ID ? "" : " with id '"
3474 + getContext().getResources().getResourceEntryName(
3475 id) + "'";
Romain Guy9a817362009-05-01 10:57:14 -07003476 throw new IllegalStateException("Could not find a method " +
Joe Onorato42e14d72010-03-11 14:51:17 -08003477 handlerName + "(View) in the activity "
3478 + getContext().getClass() + " for onClick handler"
3479 + " on view " + View.this.getClass() + idText, e);
Romain Guy9a817362009-05-01 10:57:14 -07003480 }
3481 }
3482
3483 try {
3484 mHandler.invoke(getContext(), View.this);
3485 } catch (IllegalAccessException e) {
3486 throw new IllegalStateException("Could not execute non "
3487 + "public method of the activity", e);
3488 } catch (InvocationTargetException e) {
3489 throw new IllegalStateException("Could not execute "
3490 + "method of the activity", e);
3491 }
3492 }
3493 });
3494 }
3495 break;
Adam Powell637d3372010-08-25 14:37:03 -07003496 case R.styleable.View_overScrollMode:
3497 overScrollMode = a.getInt(attr, OVER_SCROLL_IF_CONTENT_SCROLLS);
3498 break;
Adam Powell20232d02010-12-08 21:08:53 -08003499 case R.styleable.View_verticalScrollbarPosition:
3500 mVerticalScrollbarPosition = a.getInt(attr, SCROLLBAR_POSITION_DEFAULT);
3501 break;
Romain Guy171c5922011-01-06 10:04:23 -08003502 case R.styleable.View_layerType:
3503 setLayerType(a.getInt(attr, LAYER_TYPE_NONE), null);
3504 break;
Fabrice Di Meglio22268862011-06-27 18:13:18 -07003505 case R.styleable.View_textDirection:
Fabrice Di Megliob934db72012-03-20 14:33:01 -07003506 // Clear any text direction flag already set
Dianne Hackborn4702a852012-08-17 15:18:29 -07003507 mPrivateFlags2 &= ~PFLAG2_TEXT_DIRECTION_MASK;
Fabrice Di Megliob934db72012-03-20 14:33:01 -07003508 // Set the text direction flags depending on the value of the attribute
3509 final int textDirection = a.getInt(attr, -1);
3510 if (textDirection != -1) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07003511 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_FLAGS[textDirection];
Fabrice Di Megliob934db72012-03-20 14:33:01 -07003512 }
Fabrice Di Meglio22268862011-06-27 18:13:18 -07003513 break;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07003514 case R.styleable.View_textAlignment:
3515 // Clear any text alignment flag already set
Dianne Hackborn4702a852012-08-17 15:18:29 -07003516 mPrivateFlags2 &= ~PFLAG2_TEXT_ALIGNMENT_MASK;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07003517 // Set the text alignment flag depending on the value of the attribute
3518 final int textAlignment = a.getInt(attr, TEXT_ALIGNMENT_DEFAULT);
Dianne Hackborn4702a852012-08-17 15:18:29 -07003519 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_FLAGS[textAlignment];
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07003520 break;
Svetoslav Ganov42138042012-03-20 11:51:39 -07003521 case R.styleable.View_importantForAccessibility:
3522 setImportantForAccessibility(a.getInt(attr,
3523 IMPORTANT_FOR_ACCESSIBILITY_DEFAULT));
Svetoslav Ganov86783472012-06-06 21:12:20 -07003524 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003525 }
3526 }
3527
Adam Powell637d3372010-08-25 14:37:03 -07003528 setOverScrollMode(overScrollMode);
3529
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07003530 // Cache start/end user padding as we cannot fully resolve padding here (we dont have yet
3531 // the resolved layout direction). Those cached values will be used later during padding
3532 // resolution.
Fabrice Di Megliof9e36502011-06-21 18:41:48 -07003533 mUserPaddingStart = startPadding;
3534 mUserPaddingEnd = endPadding;
3535
Fabrice Di Meglio016456e2012-07-17 20:35:48 -07003536 if (background != null) {
3537 setBackground(background);
3538 }
Fabrice Di Meglio509708d2012-03-06 15:41:11 -08003539
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003540 if (padding >= 0) {
3541 leftPadding = padding;
3542 topPadding = padding;
3543 rightPadding = padding;
3544 bottomPadding = padding;
3545 }
3546
3547 // If the user specified the padding (either with android:padding or
3548 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise
3549 // use the default padding or the padding from the background drawable
3550 // (stored at this point in mPadding*)
Fabrice Di Meglio016456e2012-07-17 20:35:48 -07003551 internalSetPadding(leftPadding >= 0 ? leftPadding : mPaddingLeft,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003552 topPadding >= 0 ? topPadding : mPaddingTop,
3553 rightPadding >= 0 ? rightPadding : mPaddingRight,
3554 bottomPadding >= 0 ? bottomPadding : mPaddingBottom);
3555
3556 if (viewFlagMasks != 0) {
3557 setFlags(viewFlagValues, viewFlagMasks);
3558 }
3559
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07003560 if (initializeScrollbars) {
3561 initializeScrollbars(a);
3562 }
3563
3564 a.recycle();
3565
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003566 // Needs to be called after mViewFlags is set
3567 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
3568 recomputePadding();
3569 }
3570
3571 if (x != 0 || y != 0) {
3572 scrollTo(x, y);
3573 }
3574
Chet Haase73066682010-11-29 15:55:32 -08003575 if (transformSet) {
3576 setTranslationX(tx);
3577 setTranslationY(ty);
3578 setRotation(rotation);
3579 setRotationX(rotationX);
3580 setRotationY(rotationY);
3581 setScaleX(sx);
3582 setScaleY(sy);
3583 }
3584
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003585 if (!setScrollContainer && (viewFlagValues&SCROLLBARS_VERTICAL) != 0) {
3586 setScrollContainer(true);
3587 }
Romain Guy8f1344f52009-05-15 16:03:59 -07003588
3589 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003590 }
3591
3592 /**
3593 * Non-public constructor for use in testing
3594 */
3595 View() {
Dianne Hackbornab0f4852011-09-12 16:59:06 -07003596 mResources = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003597 }
3598
Dianne Hackborn4702a852012-08-17 15:18:29 -07003599 public String toString() {
3600 StringBuilder out = new StringBuilder(128);
3601 out.append(getClass().getName());
3602 out.append('{');
3603 out.append(Integer.toHexString(System.identityHashCode(this)));
3604 out.append(' ');
3605 switch (mViewFlags&VISIBILITY_MASK) {
3606 case VISIBLE: out.append('V'); break;
3607 case INVISIBLE: out.append('I'); break;
3608 case GONE: out.append('G'); break;
3609 default: out.append('.'); break;
3610 }
3611 out.append((mViewFlags&FOCUSABLE_MASK) == FOCUSABLE ? 'F' : '.');
3612 out.append((mViewFlags&ENABLED_MASK) == ENABLED ? 'E' : '.');
3613 out.append((mViewFlags&DRAW_MASK) == WILL_NOT_DRAW ? '.' : 'D');
3614 out.append((mViewFlags&SCROLLBARS_HORIZONTAL) != 0 ? 'H' : '.');
3615 out.append((mViewFlags&SCROLLBARS_VERTICAL) != 0 ? 'V' : '.');
3616 out.append((mViewFlags&CLICKABLE) != 0 ? 'C' : '.');
3617 out.append((mViewFlags&LONG_CLICKABLE) != 0 ? 'L' : '.');
3618 out.append(' ');
3619 out.append((mPrivateFlags&PFLAG_IS_ROOT_NAMESPACE) != 0 ? 'R' : '.');
3620 out.append((mPrivateFlags&PFLAG_FOCUSED) != 0 ? 'F' : '.');
3621 out.append((mPrivateFlags&PFLAG_SELECTED) != 0 ? 'S' : '.');
3622 if ((mPrivateFlags&PFLAG_PREPRESSED) != 0) {
3623 out.append('p');
3624 } else {
3625 out.append((mPrivateFlags&PFLAG_PRESSED) != 0 ? 'P' : '.');
3626 }
3627 out.append((mPrivateFlags&PFLAG_HOVERED) != 0 ? 'H' : '.');
3628 out.append((mPrivateFlags&PFLAG_ACTIVATED) != 0 ? 'A' : '.');
3629 out.append((mPrivateFlags&PFLAG_INVALIDATED) != 0 ? 'I' : '.');
3630 out.append((mPrivateFlags&PFLAG_DIRTY_MASK) != 0 ? 'D' : '.');
3631 out.append(' ');
3632 out.append(mLeft);
3633 out.append(',');
3634 out.append(mTop);
3635 out.append('-');
3636 out.append(mRight);
3637 out.append(',');
3638 out.append(mBottom);
3639 final int id = getId();
3640 if (id != NO_ID) {
3641 out.append(" #");
3642 out.append(Integer.toHexString(id));
3643 final Resources r = mResources;
3644 if (id != 0 && r != null) {
3645 try {
3646 String pkgname;
3647 switch (id&0xff000000) {
3648 case 0x7f000000:
3649 pkgname="app";
3650 break;
3651 case 0x01000000:
3652 pkgname="android";
3653 break;
3654 default:
3655 pkgname = r.getResourcePackageName(id);
3656 break;
3657 }
3658 String typename = r.getResourceTypeName(id);
3659 String entryname = r.getResourceEntryName(id);
3660 out.append(" ");
3661 out.append(pkgname);
3662 out.append(":");
3663 out.append(typename);
3664 out.append("/");
3665 out.append(entryname);
3666 } catch (Resources.NotFoundException e) {
3667 }
3668 }
3669 }
3670 out.append("}");
3671 return out.toString();
3672 }
3673
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003674 /**
3675 * <p>
3676 * Initializes the fading edges from a given set of styled attributes. This
3677 * method should be called by subclasses that need fading edges and when an
3678 * instance of these subclasses is created programmatically rather than
3679 * being inflated from XML. This method is automatically called when the XML
3680 * is inflated.
3681 * </p>
3682 *
3683 * @param a the styled attributes set to initialize the fading edges from
3684 */
3685 protected void initializeFadingEdge(TypedArray a) {
3686 initScrollCache();
3687
3688 mScrollCache.fadingEdgeLength = a.getDimensionPixelSize(
3689 R.styleable.View_fadingEdgeLength,
3690 ViewConfiguration.get(mContext).getScaledFadingEdgeLength());
3691 }
3692
3693 /**
3694 * Returns the size of the vertical faded edges used to indicate that more
3695 * content in this view is visible.
3696 *
3697 * @return The size in pixels of the vertical faded edge or 0 if vertical
3698 * faded edges are not enabled for this view.
3699 * @attr ref android.R.styleable#View_fadingEdgeLength
3700 */
3701 public int getVerticalFadingEdgeLength() {
3702 if (isVerticalFadingEdgeEnabled()) {
3703 ScrollabilityCache cache = mScrollCache;
3704 if (cache != null) {
3705 return cache.fadingEdgeLength;
3706 }
3707 }
3708 return 0;
3709 }
3710
3711 /**
3712 * Set the size of the faded edge used to indicate that more content in this
3713 * view is available. Will not change whether the fading edge is enabled; use
Romain Guy5c22a8c2011-05-13 11:48:45 -07003714 * {@link #setVerticalFadingEdgeEnabled(boolean)} or
3715 * {@link #setHorizontalFadingEdgeEnabled(boolean)} to enable the fading edge
3716 * for the vertical or horizontal fading edges.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003717 *
3718 * @param length The size in pixels of the faded edge used to indicate that more
3719 * content in this view is visible.
3720 */
3721 public void setFadingEdgeLength(int length) {
3722 initScrollCache();
3723 mScrollCache.fadingEdgeLength = length;
3724 }
3725
3726 /**
3727 * Returns the size of the horizontal faded edges used to indicate that more
3728 * content in this view is visible.
3729 *
3730 * @return The size in pixels of the horizontal faded edge or 0 if horizontal
3731 * faded edges are not enabled for this view.
3732 * @attr ref android.R.styleable#View_fadingEdgeLength
3733 */
3734 public int getHorizontalFadingEdgeLength() {
3735 if (isHorizontalFadingEdgeEnabled()) {
3736 ScrollabilityCache cache = mScrollCache;
3737 if (cache != null) {
3738 return cache.fadingEdgeLength;
3739 }
3740 }
3741 return 0;
3742 }
3743
3744 /**
3745 * Returns the width of the vertical scrollbar.
3746 *
3747 * @return The width in pixels of the vertical scrollbar or 0 if there
3748 * is no vertical scrollbar.
3749 */
3750 public int getVerticalScrollbarWidth() {
3751 ScrollabilityCache cache = mScrollCache;
3752 if (cache != null) {
3753 ScrollBarDrawable scrollBar = cache.scrollBar;
3754 if (scrollBar != null) {
3755 int size = scrollBar.getSize(true);
3756 if (size <= 0) {
3757 size = cache.scrollBarSize;
3758 }
3759 return size;
3760 }
3761 return 0;
3762 }
3763 return 0;
3764 }
3765
3766 /**
3767 * Returns the height of the horizontal scrollbar.
3768 *
3769 * @return The height in pixels of the horizontal scrollbar or 0 if
3770 * there is no horizontal scrollbar.
3771 */
3772 protected int getHorizontalScrollbarHeight() {
3773 ScrollabilityCache cache = mScrollCache;
3774 if (cache != null) {
3775 ScrollBarDrawable scrollBar = cache.scrollBar;
3776 if (scrollBar != null) {
3777 int size = scrollBar.getSize(false);
3778 if (size <= 0) {
3779 size = cache.scrollBarSize;
3780 }
3781 return size;
3782 }
3783 return 0;
3784 }
3785 return 0;
3786 }
3787
3788 /**
3789 * <p>
3790 * Initializes the scrollbars from a given set of styled attributes. This
3791 * method should be called by subclasses that need scrollbars and when an
3792 * instance of these subclasses is created programmatically rather than
3793 * being inflated from XML. This method is automatically called when the XML
3794 * is inflated.
3795 * </p>
3796 *
3797 * @param a the styled attributes set to initialize the scrollbars from
3798 */
3799 protected void initializeScrollbars(TypedArray a) {
3800 initScrollCache();
3801
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003802 final ScrollabilityCache scrollabilityCache = mScrollCache;
Joe Malin32736f02011-01-19 16:14:20 -08003803
Mike Cleronf116bf82009-09-27 19:14:12 -07003804 if (scrollabilityCache.scrollBar == null) {
3805 scrollabilityCache.scrollBar = new ScrollBarDrawable();
3806 }
Joe Malin32736f02011-01-19 16:14:20 -08003807
Romain Guy8bda2482010-03-02 11:42:11 -08003808 final boolean fadeScrollbars = a.getBoolean(R.styleable.View_fadeScrollbars, true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003809
Mike Cleronf116bf82009-09-27 19:14:12 -07003810 if (!fadeScrollbars) {
3811 scrollabilityCache.state = ScrollabilityCache.ON;
3812 }
3813 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Joe Malin32736f02011-01-19 16:14:20 -08003814
3815
Mike Cleronf116bf82009-09-27 19:14:12 -07003816 scrollabilityCache.scrollBarFadeDuration = a.getInt(
3817 R.styleable.View_scrollbarFadeDuration, ViewConfiguration
3818 .getScrollBarFadeDuration());
3819 scrollabilityCache.scrollBarDefaultDelayBeforeFade = a.getInt(
3820 R.styleable.View_scrollbarDefaultDelayBeforeFade,
3821 ViewConfiguration.getScrollDefaultDelay());
3822
Joe Malin32736f02011-01-19 16:14:20 -08003823
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003824 scrollabilityCache.scrollBarSize = a.getDimensionPixelSize(
3825 com.android.internal.R.styleable.View_scrollbarSize,
3826 ViewConfiguration.get(mContext).getScaledScrollBarSize());
3827
3828 Drawable track = a.getDrawable(R.styleable.View_scrollbarTrackHorizontal);
3829 scrollabilityCache.scrollBar.setHorizontalTrackDrawable(track);
3830
3831 Drawable thumb = a.getDrawable(R.styleable.View_scrollbarThumbHorizontal);
3832 if (thumb != null) {
3833 scrollabilityCache.scrollBar.setHorizontalThumbDrawable(thumb);
3834 }
3835
3836 boolean alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawHorizontalTrack,
3837 false);
3838 if (alwaysDraw) {
3839 scrollabilityCache.scrollBar.setAlwaysDrawHorizontalTrack(true);
3840 }
3841
3842 track = a.getDrawable(R.styleable.View_scrollbarTrackVertical);
3843 scrollabilityCache.scrollBar.setVerticalTrackDrawable(track);
3844
3845 thumb = a.getDrawable(R.styleable.View_scrollbarThumbVertical);
3846 if (thumb != null) {
3847 scrollabilityCache.scrollBar.setVerticalThumbDrawable(thumb);
3848 }
3849
3850 alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawVerticalTrack,
3851 false);
3852 if (alwaysDraw) {
3853 scrollabilityCache.scrollBar.setAlwaysDrawVerticalTrack(true);
3854 }
3855
Fabrice Di Megliob03b4342012-06-04 12:55:30 -07003856 // Apply layout direction to the new Drawables if needed
3857 final int layoutDirection = getResolvedLayoutDirection();
3858 if (track != null) {
3859 track.setLayoutDirection(layoutDirection);
3860 }
3861 if (thumb != null) {
3862 thumb.setLayoutDirection(layoutDirection);
3863 }
3864
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003865 // Re-apply user/background padding so that scrollbar(s) get added
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003866 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003867 }
3868
3869 /**
3870 * <p>
3871 * Initalizes the scrollability cache if necessary.
3872 * </p>
3873 */
3874 private void initScrollCache() {
3875 if (mScrollCache == null) {
Mike Cleronf116bf82009-09-27 19:14:12 -07003876 mScrollCache = new ScrollabilityCache(ViewConfiguration.get(mContext), this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003877 }
3878 }
3879
Philip Milne6c8ea062012-04-03 17:38:43 -07003880 private ScrollabilityCache getScrollCache() {
3881 initScrollCache();
3882 return mScrollCache;
3883 }
3884
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003885 /**
Adam Powell20232d02010-12-08 21:08:53 -08003886 * Set the position of the vertical scroll bar. Should be one of
3887 * {@link #SCROLLBAR_POSITION_DEFAULT}, {@link #SCROLLBAR_POSITION_LEFT} or
3888 * {@link #SCROLLBAR_POSITION_RIGHT}.
3889 *
3890 * @param position Where the vertical scroll bar should be positioned.
3891 */
3892 public void setVerticalScrollbarPosition(int position) {
3893 if (mVerticalScrollbarPosition != position) {
3894 mVerticalScrollbarPosition = position;
3895 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003896 resolvePadding();
Adam Powell20232d02010-12-08 21:08:53 -08003897 }
3898 }
3899
3900 /**
3901 * @return The position where the vertical scroll bar will show, if applicable.
3902 * @see #setVerticalScrollbarPosition(int)
3903 */
3904 public int getVerticalScrollbarPosition() {
3905 return mVerticalScrollbarPosition;
3906 }
3907
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003908 ListenerInfo getListenerInfo() {
3909 if (mListenerInfo != null) {
3910 return mListenerInfo;
3911 }
3912 mListenerInfo = new ListenerInfo();
3913 return mListenerInfo;
3914 }
3915
Adam Powell20232d02010-12-08 21:08:53 -08003916 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003917 * Register a callback to be invoked when focus of this view changed.
3918 *
3919 * @param l The callback that will run.
3920 */
3921 public void setOnFocusChangeListener(OnFocusChangeListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003922 getListenerInfo().mOnFocusChangeListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003923 }
3924
3925 /**
Chet Haase21cd1382010-09-01 17:42:29 -07003926 * Add a listener that will be called when the bounds of the view change due to
3927 * layout processing.
3928 *
3929 * @param listener The listener that will be called when layout bounds change.
3930 */
3931 public void addOnLayoutChangeListener(OnLayoutChangeListener listener) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003932 ListenerInfo li = getListenerInfo();
3933 if (li.mOnLayoutChangeListeners == null) {
3934 li.mOnLayoutChangeListeners = new ArrayList<OnLayoutChangeListener>();
Chet Haase21cd1382010-09-01 17:42:29 -07003935 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003936 if (!li.mOnLayoutChangeListeners.contains(listener)) {
3937 li.mOnLayoutChangeListeners.add(listener);
Chet Haase1a76dcd2011-10-06 11:16:40 -07003938 }
Chet Haase21cd1382010-09-01 17:42:29 -07003939 }
3940
3941 /**
3942 * Remove a listener for layout changes.
3943 *
3944 * @param listener The listener for layout bounds change.
3945 */
3946 public void removeOnLayoutChangeListener(OnLayoutChangeListener listener) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003947 ListenerInfo li = mListenerInfo;
3948 if (li == null || li.mOnLayoutChangeListeners == null) {
Chet Haase21cd1382010-09-01 17:42:29 -07003949 return;
3950 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003951 li.mOnLayoutChangeListeners.remove(listener);
Chet Haase21cd1382010-09-01 17:42:29 -07003952 }
3953
3954 /**
Adam Powell4afd62b2011-02-18 15:02:18 -08003955 * Add a listener for attach state changes.
3956 *
3957 * This listener will be called whenever this view is attached or detached
3958 * from a window. Remove the listener using
3959 * {@link #removeOnAttachStateChangeListener(OnAttachStateChangeListener)}.
3960 *
3961 * @param listener Listener to attach
3962 * @see #removeOnAttachStateChangeListener(OnAttachStateChangeListener)
3963 */
3964 public void addOnAttachStateChangeListener(OnAttachStateChangeListener listener) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003965 ListenerInfo li = getListenerInfo();
3966 if (li.mOnAttachStateChangeListeners == null) {
3967 li.mOnAttachStateChangeListeners
3968 = new CopyOnWriteArrayList<OnAttachStateChangeListener>();
Adam Powell4afd62b2011-02-18 15:02:18 -08003969 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003970 li.mOnAttachStateChangeListeners.add(listener);
Adam Powell4afd62b2011-02-18 15:02:18 -08003971 }
3972
3973 /**
3974 * Remove a listener for attach state changes. The listener will receive no further
3975 * notification of window attach/detach events.
3976 *
3977 * @param listener Listener to remove
3978 * @see #addOnAttachStateChangeListener(OnAttachStateChangeListener)
3979 */
3980 public void removeOnAttachStateChangeListener(OnAttachStateChangeListener listener) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003981 ListenerInfo li = mListenerInfo;
3982 if (li == null || li.mOnAttachStateChangeListeners == null) {
Adam Powell4afd62b2011-02-18 15:02:18 -08003983 return;
3984 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003985 li.mOnAttachStateChangeListeners.remove(listener);
Adam Powell4afd62b2011-02-18 15:02:18 -08003986 }
3987
3988 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003989 * Returns the focus-change callback registered for this view.
3990 *
3991 * @return The callback, or null if one is not registered.
3992 */
3993 public OnFocusChangeListener getOnFocusChangeListener() {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003994 ListenerInfo li = mListenerInfo;
3995 return li != null ? li.mOnFocusChangeListener : null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003996 }
3997
3998 /**
3999 * Register a callback to be invoked when this view is clicked. If this view is not
4000 * clickable, it becomes clickable.
4001 *
4002 * @param l The callback that will run
4003 *
4004 * @see #setClickable(boolean)
4005 */
4006 public void setOnClickListener(OnClickListener l) {
4007 if (!isClickable()) {
4008 setClickable(true);
4009 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004010 getListenerInfo().mOnClickListener = l;
4011 }
4012
4013 /**
4014 * Return whether this view has an attached OnClickListener. Returns
4015 * true if there is a listener, false if there is none.
4016 */
4017 public boolean hasOnClickListeners() {
4018 ListenerInfo li = mListenerInfo;
4019 return (li != null && li.mOnClickListener != null);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004020 }
4021
4022 /**
4023 * Register a callback to be invoked when this view is clicked and held. If this view is not
4024 * long clickable, it becomes long clickable.
4025 *
4026 * @param l The callback that will run
4027 *
4028 * @see #setLongClickable(boolean)
4029 */
4030 public void setOnLongClickListener(OnLongClickListener l) {
4031 if (!isLongClickable()) {
4032 setLongClickable(true);
4033 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004034 getListenerInfo().mOnLongClickListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004035 }
4036
4037 /**
4038 * Register a callback to be invoked when the context menu for this view is
4039 * being built. If this view is not long clickable, it becomes long clickable.
4040 *
4041 * @param l The callback that will run
4042 *
4043 */
4044 public void setOnCreateContextMenuListener(OnCreateContextMenuListener l) {
4045 if (!isLongClickable()) {
4046 setLongClickable(true);
4047 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004048 getListenerInfo().mOnCreateContextMenuListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004049 }
4050
4051 /**
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004052 * Call this view's OnClickListener, if it is defined. Performs all normal
4053 * actions associated with clicking: reporting accessibility event, playing
4054 * a sound, etc.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004055 *
4056 * @return True there was an assigned OnClickListener that was called, false
4057 * otherwise is returned.
4058 */
4059 public boolean performClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07004060 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED);
4061
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004062 ListenerInfo li = mListenerInfo;
4063 if (li != null && li.mOnClickListener != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004064 playSoundEffect(SoundEffectConstants.CLICK);
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004065 li.mOnClickListener.onClick(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004066 return true;
4067 }
4068
4069 return false;
4070 }
4071
4072 /**
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004073 * Directly call any attached OnClickListener. Unlike {@link #performClick()},
4074 * this only calls the listener, and does not do any associated clicking
4075 * actions like reporting an accessibility event.
4076 *
4077 * @return True there was an assigned OnClickListener that was called, false
4078 * otherwise is returned.
4079 */
4080 public boolean callOnClick() {
4081 ListenerInfo li = mListenerInfo;
4082 if (li != null && li.mOnClickListener != null) {
4083 li.mOnClickListener.onClick(this);
4084 return true;
4085 }
4086 return false;
4087 }
4088
4089 /**
Gilles Debunnef788a9f2010-07-22 10:17:23 -07004090 * Call this view's OnLongClickListener, if it is defined. Invokes the context menu if the
4091 * OnLongClickListener did not consume the event.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004092 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07004093 * @return True if one of the above receivers consumed the event, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004094 */
4095 public boolean performLongClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07004096 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED);
4097
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004098 boolean handled = false;
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004099 ListenerInfo li = mListenerInfo;
4100 if (li != null && li.mOnLongClickListener != null) {
4101 handled = li.mOnLongClickListener.onLongClick(View.this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004102 }
4103 if (!handled) {
4104 handled = showContextMenu();
4105 }
4106 if (handled) {
4107 performHapticFeedback(HapticFeedbackConstants.LONG_PRESS);
4108 }
4109 return handled;
4110 }
4111
4112 /**
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07004113 * Performs button-related actions during a touch down event.
4114 *
4115 * @param event The event.
4116 * @return True if the down was consumed.
4117 *
4118 * @hide
4119 */
4120 protected boolean performButtonActionOnTouchDown(MotionEvent event) {
4121 if ((event.getButtonState() & MotionEvent.BUTTON_SECONDARY) != 0) {
4122 if (showContextMenu(event.getX(), event.getY(), event.getMetaState())) {
4123 return true;
4124 }
4125 }
4126 return false;
4127 }
4128
4129 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004130 * Bring up the context menu for this view.
4131 *
4132 * @return Whether a context menu was displayed.
4133 */
4134 public boolean showContextMenu() {
4135 return getParent().showContextMenuForChild(this);
4136 }
4137
4138 /**
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07004139 * Bring up the context menu for this view, referring to the item under the specified point.
4140 *
4141 * @param x The referenced x coordinate.
4142 * @param y The referenced y coordinate.
4143 * @param metaState The keyboard modifiers that were pressed.
4144 * @return Whether a context menu was displayed.
4145 *
4146 * @hide
4147 */
4148 public boolean showContextMenu(float x, float y, int metaState) {
4149 return showContextMenu();
4150 }
4151
4152 /**
Adam Powell6e346362010-07-23 10:18:23 -07004153 * Start an action mode.
4154 *
4155 * @param callback Callback that will control the lifecycle of the action mode
4156 * @return The new action mode if it is started, null otherwise
4157 *
4158 * @see ActionMode
4159 */
4160 public ActionMode startActionMode(ActionMode.Callback callback) {
John Reck5160e2a2012-02-22 09:35:12 -08004161 ViewParent parent = getParent();
4162 if (parent == null) return null;
4163 return parent.startActionModeForChild(this, callback);
Adam Powell6e346362010-07-23 10:18:23 -07004164 }
4165
4166 /**
Jean Chalard405bc512012-05-29 19:12:34 +09004167 * Register a callback to be invoked when a hardware key is pressed in this view.
4168 * Key presses in software input methods will generally not trigger the methods of
4169 * this listener.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004170 * @param l the key listener to attach to this view
4171 */
4172 public void setOnKeyListener(OnKeyListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004173 getListenerInfo().mOnKeyListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004174 }
4175
4176 /**
4177 * Register a callback to be invoked when a touch event is sent to this view.
4178 * @param l the touch listener to attach to this view
4179 */
4180 public void setOnTouchListener(OnTouchListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004181 getListenerInfo().mOnTouchListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004182 }
4183
4184 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08004185 * Register a callback to be invoked when a generic motion event is sent to this view.
4186 * @param l the generic motion listener to attach to this view
4187 */
4188 public void setOnGenericMotionListener(OnGenericMotionListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004189 getListenerInfo().mOnGenericMotionListener = l;
Jeff Brown33bbfd22011-02-24 20:55:35 -08004190 }
4191
4192 /**
Jeff Brown53ca3f12011-06-27 18:36:00 -07004193 * Register a callback to be invoked when a hover event is sent to this view.
4194 * @param l the hover listener to attach to this view
4195 */
4196 public void setOnHoverListener(OnHoverListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004197 getListenerInfo().mOnHoverListener = l;
Jeff Brown53ca3f12011-06-27 18:36:00 -07004198 }
4199
4200 /**
Joe Malin32736f02011-01-19 16:14:20 -08004201 * Register a drag event listener callback object for this View. The parameter is
4202 * an implementation of {@link android.view.View.OnDragListener}. To send a drag event to a
4203 * View, the system calls the
4204 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent)} method.
4205 * @param l An implementation of {@link android.view.View.OnDragListener}.
Chris Tate32affef2010-10-18 15:29:21 -07004206 */
4207 public void setOnDragListener(OnDragListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004208 getListenerInfo().mOnDragListener = l;
Chris Tate32affef2010-10-18 15:29:21 -07004209 }
4210
4211 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07004212 * Give this view focus. This will cause
4213 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} to be called.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004214 *
4215 * Note: this does not check whether this {@link View} should get focus, it just
4216 * gives it focus no matter what. It should only be called internally by framework
4217 * code that knows what it is doing, namely {@link #requestFocus(int, Rect)}.
4218 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08004219 * @param direction values are {@link View#FOCUS_UP}, {@link View#FOCUS_DOWN},
4220 * {@link View#FOCUS_LEFT} or {@link View#FOCUS_RIGHT}. This is the direction which
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004221 * focus moved when requestFocus() is called. It may not always
4222 * apply, in which case use the default View.FOCUS_DOWN.
4223 * @param previouslyFocusedRect The rectangle of the view that had focus
4224 * prior in this View's coordinate system.
4225 */
4226 void handleFocusGainInternal(int direction, Rect previouslyFocusedRect) {
4227 if (DBG) {
4228 System.out.println(this + " requestFocus()");
4229 }
4230
Dianne Hackborn4702a852012-08-17 15:18:29 -07004231 if ((mPrivateFlags & PFLAG_FOCUSED) == 0) {
4232 mPrivateFlags |= PFLAG_FOCUSED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004233
4234 if (mParent != null) {
4235 mParent.requestChildFocus(this, this);
4236 }
4237
4238 onFocusChanged(true, direction, previouslyFocusedRect);
4239 refreshDrawableState();
Svetoslav Ganov42138042012-03-20 11:51:39 -07004240
4241 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4242 notifyAccessibilityStateChanged();
4243 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004244 }
4245 }
4246
4247 /**
4248 * Request that a rectangle of this view be visible on the screen,
4249 * scrolling if necessary just enough.
4250 *
4251 * <p>A View should call this if it maintains some notion of which part
4252 * of its content is interesting. For example, a text editing view
4253 * should call this when its cursor moves.
4254 *
4255 * @param rectangle The rectangle.
4256 * @return Whether any parent scrolled.
4257 */
4258 public boolean requestRectangleOnScreen(Rect rectangle) {
4259 return requestRectangleOnScreen(rectangle, false);
4260 }
4261
4262 /**
4263 * Request that a rectangle of this view be visible on the screen,
4264 * scrolling if necessary just enough.
4265 *
4266 * <p>A View should call this if it maintains some notion of which part
4267 * of its content is interesting. For example, a text editing view
4268 * should call this when its cursor moves.
4269 *
4270 * <p>When <code>immediate</code> is set to true, scrolling will not be
4271 * animated.
4272 *
4273 * @param rectangle The rectangle.
4274 * @param immediate True to forbid animated scrolling, false otherwise
4275 * @return Whether any parent scrolled.
4276 */
4277 public boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) {
4278 View child = this;
4279 ViewParent parent = mParent;
4280 boolean scrolled = false;
4281 while (parent != null) {
4282 scrolled |= parent.requestChildRectangleOnScreen(child,
4283 rectangle, immediate);
4284
4285 // offset rect so next call has the rectangle in the
4286 // coordinate system of its direct child.
4287 rectangle.offset(child.getLeft(), child.getTop());
4288 rectangle.offset(-child.getScrollX(), -child.getScrollY());
4289
4290 if (!(parent instanceof View)) {
4291 break;
4292 }
Romain Guy8506ab42009-06-11 17:35:47 -07004293
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004294 child = (View) parent;
4295 parent = child.getParent();
4296 }
4297 return scrolled;
4298 }
4299
4300 /**
Svetoslav Ganov13fd5612012-02-01 17:01:12 -08004301 * Called when this view wants to give up focus. If focus is cleared
4302 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} is called.
4303 * <p>
4304 * <strong>Note:</strong> When a View clears focus the framework is trying
4305 * to give focus to the first focusable View from the top. Hence, if this
Svetoslav Ganov57cadf22012-04-04 16:44:39 -07004306 * View is the first from the top that can take focus, then all callbacks
4307 * related to clearing focus will be invoked after wich the framework will
4308 * give focus to this view.
Svetoslav Ganov13fd5612012-02-01 17:01:12 -08004309 * </p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004310 */
4311 public void clearFocus() {
4312 if (DBG) {
4313 System.out.println(this + " clearFocus()");
4314 }
4315
Dianne Hackborn4702a852012-08-17 15:18:29 -07004316 if ((mPrivateFlags & PFLAG_FOCUSED) != 0) {
4317 mPrivateFlags &= ~PFLAG_FOCUSED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004318
4319 if (mParent != null) {
4320 mParent.clearChildFocus(this);
4321 }
4322
4323 onFocusChanged(false, 0, null);
Svetoslav Ganov42138042012-03-20 11:51:39 -07004324
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004325 refreshDrawableState();
Svetoslav Ganov57cadf22012-04-04 16:44:39 -07004326
4327 ensureInputFocusOnFirstFocusable();
Svetoslav Ganov42138042012-03-20 11:51:39 -07004328
4329 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4330 notifyAccessibilityStateChanged();
4331 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004332 }
4333 }
4334
Svetoslav Ganov57cadf22012-04-04 16:44:39 -07004335 void ensureInputFocusOnFirstFocusable() {
4336 View root = getRootView();
4337 if (root != null) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004338 root.requestFocus();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004339 }
4340 }
4341
4342 /**
4343 * Called internally by the view system when a new view is getting focus.
4344 * This is what clears the old focus.
4345 */
4346 void unFocus() {
4347 if (DBG) {
4348 System.out.println(this + " unFocus()");
4349 }
4350
Dianne Hackborn4702a852012-08-17 15:18:29 -07004351 if ((mPrivateFlags & PFLAG_FOCUSED) != 0) {
4352 mPrivateFlags &= ~PFLAG_FOCUSED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004353
4354 onFocusChanged(false, 0, null);
4355 refreshDrawableState();
Svetoslav Ganov42138042012-03-20 11:51:39 -07004356
4357 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4358 notifyAccessibilityStateChanged();
4359 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004360 }
4361 }
4362
4363 /**
4364 * Returns true if this view has focus iteself, or is the ancestor of the
4365 * view that has focus.
4366 *
4367 * @return True if this view has or contains focus, false otherwise.
4368 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004369 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004370 public boolean hasFocus() {
Dianne Hackborn4702a852012-08-17 15:18:29 -07004371 return (mPrivateFlags & PFLAG_FOCUSED) != 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004372 }
4373
4374 /**
4375 * Returns true if this view is focusable or if it contains a reachable View
4376 * for which {@link #hasFocusable()} returns true. A "reachable hasFocusable()"
4377 * is a View whose parents do not block descendants focus.
4378 *
4379 * Only {@link #VISIBLE} views are considered focusable.
4380 *
4381 * @return True if the view is focusable or if the view contains a focusable
4382 * View, false otherwise.
4383 *
4384 * @see ViewGroup#FOCUS_BLOCK_DESCENDANTS
4385 */
4386 public boolean hasFocusable() {
4387 return (mViewFlags & VISIBILITY_MASK) == VISIBLE && isFocusable();
4388 }
4389
4390 /**
4391 * Called by the view system when the focus state of this view changes.
4392 * When the focus change event is caused by directional navigation, direction
4393 * and previouslyFocusedRect provide insight into where the focus is coming from.
4394 * When overriding, be sure to call up through to the super class so that
4395 * the standard focus handling will occur.
Romain Guy8506ab42009-06-11 17:35:47 -07004396 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004397 * @param gainFocus True if the View has focus; false otherwise.
4398 * @param direction The direction focus has moved when requestFocus()
4399 * is called to give this view focus. Values are
Jeff Brown4e6319b2010-12-13 10:36:51 -08004400 * {@link #FOCUS_UP}, {@link #FOCUS_DOWN}, {@link #FOCUS_LEFT},
4401 * {@link #FOCUS_RIGHT}, {@link #FOCUS_FORWARD}, or {@link #FOCUS_BACKWARD}.
4402 * It may not always apply, in which case use the default.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004403 * @param previouslyFocusedRect The rectangle, in this view's coordinate
4404 * system, of the previously focused view. If applicable, this will be
4405 * passed in as finer grained information about where the focus is coming
4406 * from (in addition to direction). Will be <code>null</code> otherwise.
4407 */
4408 protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) {
svetoslavganov75986cf2009-05-14 22:28:01 -07004409 if (gainFocus) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004410 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4411 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED);
Svetoslav Ganov42138042012-03-20 11:51:39 -07004412 }
svetoslavganov75986cf2009-05-14 22:28:01 -07004413 }
4414
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004415 InputMethodManager imm = InputMethodManager.peekInstance();
4416 if (!gainFocus) {
4417 if (isPressed()) {
4418 setPressed(false);
4419 }
4420 if (imm != null && mAttachInfo != null
4421 && mAttachInfo.mHasWindowFocus) {
4422 imm.focusOut(this);
4423 }
Romain Guya2431d02009-04-30 16:30:00 -07004424 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004425 } else if (imm != null && mAttachInfo != null
4426 && mAttachInfo.mHasWindowFocus) {
4427 imm.focusIn(this);
4428 }
Romain Guy8506ab42009-06-11 17:35:47 -07004429
Romain Guy0fd89bf2011-01-26 15:41:30 -08004430 invalidate(true);
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004431 ListenerInfo li = mListenerInfo;
4432 if (li != null && li.mOnFocusChangeListener != null) {
4433 li.mOnFocusChangeListener.onFocusChange(this, gainFocus);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004434 }
Joe Malin32736f02011-01-19 16:14:20 -08004435
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004436 if (mAttachInfo != null) {
4437 mAttachInfo.mKeyDispatchState.reset(this);
4438 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004439 }
4440
4441 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07004442 * Sends an accessibility event of the given type. If accessiiblity is
4443 * not enabled this method has no effect. The default implementation calls
4444 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)} first
4445 * to populate information about the event source (this View), then calls
4446 * {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)} to
4447 * populate the text content of the event source including its descendants,
4448 * and last calls
4449 * {@link ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent)}
4450 * on its parent to resuest sending of the event to interested parties.
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004451 * <p>
4452 * If an {@link AccessibilityDelegate} has been specified via calling
4453 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4454 * {@link AccessibilityDelegate#sendAccessibilityEvent(View, int)} is
4455 * responsible for handling this call.
4456 * </p>
Svetoslav Ganov30401322011-05-12 18:53:45 -07004457 *
Scott Mainb303d832011-10-12 16:45:18 -07004458 * @param eventType The type of the event to send, as defined by several types from
4459 * {@link android.view.accessibility.AccessibilityEvent}, such as
4460 * {@link android.view.accessibility.AccessibilityEvent#TYPE_VIEW_CLICKED} or
4461 * {@link android.view.accessibility.AccessibilityEvent#TYPE_VIEW_HOVER_ENTER}.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004462 *
4463 * @see #onInitializeAccessibilityEvent(AccessibilityEvent)
4464 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
4465 * @see ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent)
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004466 * @see AccessibilityDelegate
svetoslavganov75986cf2009-05-14 22:28:01 -07004467 */
4468 public void sendAccessibilityEvent(int eventType) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004469 if (mAccessibilityDelegate != null) {
4470 mAccessibilityDelegate.sendAccessibilityEvent(this, eventType);
4471 } else {
4472 sendAccessibilityEventInternal(eventType);
4473 }
4474 }
4475
4476 /**
Svetoslav Ganov51ab90c2012-03-09 10:54:49 -08004477 * Convenience method for sending a {@link AccessibilityEvent#TYPE_ANNOUNCEMENT}
4478 * {@link AccessibilityEvent} to make an announcement which is related to some
4479 * sort of a context change for which none of the events representing UI transitions
4480 * is a good fit. For example, announcing a new page in a book. If accessibility
4481 * is not enabled this method does nothing.
4482 *
4483 * @param text The announcement text.
4484 */
4485 public void announceForAccessibility(CharSequence text) {
Svetoslav Ganov7a82b2b2012-07-02 18:33:23 -07004486 if (AccessibilityManager.getInstance(mContext).isEnabled() && mParent != null) {
Svetoslav Ganov51ab90c2012-03-09 10:54:49 -08004487 AccessibilityEvent event = AccessibilityEvent.obtain(
4488 AccessibilityEvent.TYPE_ANNOUNCEMENT);
Svetoslav Ganov7a82b2b2012-07-02 18:33:23 -07004489 onInitializeAccessibilityEvent(event);
Svetoslav Ganov51ab90c2012-03-09 10:54:49 -08004490 event.getText().add(text);
Svetoslav Ganov7a82b2b2012-07-02 18:33:23 -07004491 event.setContentDescription(null);
4492 mParent.requestSendAccessibilityEvent(this, event);
Svetoslav Ganov51ab90c2012-03-09 10:54:49 -08004493 }
4494 }
4495
4496 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004497 * @see #sendAccessibilityEvent(int)
4498 *
4499 * Note: Called from the default {@link AccessibilityDelegate}.
4500 */
4501 void sendAccessibilityEventInternal(int eventType) {
svetoslavganov75986cf2009-05-14 22:28:01 -07004502 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4503 sendAccessibilityEventUnchecked(AccessibilityEvent.obtain(eventType));
4504 }
4505 }
4506
4507 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07004508 * This method behaves exactly as {@link #sendAccessibilityEvent(int)} but
4509 * takes as an argument an empty {@link AccessibilityEvent} and does not
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004510 * perform a check whether accessibility is enabled.
4511 * <p>
4512 * If an {@link AccessibilityDelegate} has been specified via calling
4513 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4514 * {@link AccessibilityDelegate#sendAccessibilityEventUnchecked(View, AccessibilityEvent)}
4515 * is responsible for handling this call.
4516 * </p>
Svetoslav Ganov30401322011-05-12 18:53:45 -07004517 *
4518 * @param event The event to send.
4519 *
4520 * @see #sendAccessibilityEvent(int)
svetoslavganov75986cf2009-05-14 22:28:01 -07004521 */
4522 public void sendAccessibilityEventUnchecked(AccessibilityEvent event) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004523 if (mAccessibilityDelegate != null) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004524 mAccessibilityDelegate.sendAccessibilityEventUnchecked(this, event);
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004525 } else {
4526 sendAccessibilityEventUncheckedInternal(event);
4527 }
4528 }
4529
4530 /**
4531 * @see #sendAccessibilityEventUnchecked(AccessibilityEvent)
4532 *
4533 * Note: Called from the default {@link AccessibilityDelegate}.
4534 */
4535 void sendAccessibilityEventUncheckedInternal(AccessibilityEvent event) {
Svetoslav Ganov9cd1eca2011-01-13 14:24:02 -08004536 if (!isShown()) {
4537 return;
4538 }
Svetoslav Ganov30401322011-05-12 18:53:45 -07004539 onInitializeAccessibilityEvent(event);
Svetoslav Ganov82e236d2011-09-29 19:31:06 -07004540 // Only a subset of accessibility events populates text content.
4541 if ((event.getEventType() & POPULATING_ACCESSIBILITY_EVENT_TYPES) != 0) {
4542 dispatchPopulateAccessibilityEvent(event);
4543 }
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004544 // In the beginning we called #isShown(), so we know that getParent() is not null.
4545 getParent().requestSendAccessibilityEvent(this, event);
svetoslavganov75986cf2009-05-14 22:28:01 -07004546 }
4547
4548 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07004549 * Dispatches an {@link AccessibilityEvent} to the {@link View} first and then
4550 * to its children for adding their text content to the event. Note that the
4551 * event text is populated in a separate dispatch path since we add to the
4552 * event not only the text of the source but also the text of all its descendants.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004553 * A typical implementation will call
4554 * {@link #onPopulateAccessibilityEvent(AccessibilityEvent)} on the this view
4555 * and then call the {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)}
4556 * on each child. Override this method if custom population of the event text
4557 * content is required.
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004558 * <p>
4559 * If an {@link AccessibilityDelegate} has been specified via calling
4560 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4561 * {@link AccessibilityDelegate#dispatchPopulateAccessibilityEvent(View, AccessibilityEvent)}
4562 * is responsible for handling this call.
4563 * </p>
Svetoslav Ganov82e236d2011-09-29 19:31:06 -07004564 * <p>
4565 * <em>Note:</em> Accessibility events of certain types are not dispatched for
4566 * populating the event text via this method. For details refer to {@link AccessibilityEvent}.
4567 * </p>
svetoslavganov75986cf2009-05-14 22:28:01 -07004568 *
4569 * @param event The event.
4570 *
4571 * @return True if the event population was completed.
4572 */
4573 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004574 if (mAccessibilityDelegate != null) {
4575 return mAccessibilityDelegate.dispatchPopulateAccessibilityEvent(this, event);
4576 } else {
4577 return dispatchPopulateAccessibilityEventInternal(event);
4578 }
4579 }
4580
4581 /**
4582 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
4583 *
4584 * Note: Called from the default {@link AccessibilityDelegate}.
4585 */
4586 boolean dispatchPopulateAccessibilityEventInternal(AccessibilityEvent event) {
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004587 onPopulateAccessibilityEvent(event);
svetoslavganov75986cf2009-05-14 22:28:01 -07004588 return false;
4589 }
4590
4591 /**
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004592 * Called from {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)}
Svetoslav Ganov30401322011-05-12 18:53:45 -07004593 * giving a chance to this View to populate the accessibility event with its
Scott Mainb303d832011-10-12 16:45:18 -07004594 * text content. While this method is free to modify event
4595 * attributes other than text content, doing so should normally be performed in
Svetoslav Ganov30401322011-05-12 18:53:45 -07004596 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)}.
4597 * <p>
4598 * Example: Adding formatted date string to an accessibility event in addition
Scott Mainb303d832011-10-12 16:45:18 -07004599 * to the text added by the super implementation:
4600 * <pre> public void onPopulateAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov30401322011-05-12 18:53:45 -07004601 * super.onPopulateAccessibilityEvent(event);
4602 * final int flags = DateUtils.FORMAT_SHOW_DATE | DateUtils.FORMAT_SHOW_WEEKDAY;
4603 * String selectedDateUtterance = DateUtils.formatDateTime(mContext,
4604 * mCurrentDate.getTimeInMillis(), flags);
4605 * event.getText().add(selectedDateUtterance);
Scott Mainb303d832011-10-12 16:45:18 -07004606 * }</pre>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004607 * <p>
4608 * If an {@link AccessibilityDelegate} has been specified via calling
4609 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4610 * {@link AccessibilityDelegate#onPopulateAccessibilityEvent(View, AccessibilityEvent)}
4611 * is responsible for handling this call.
4612 * </p>
Scott Mainb303d832011-10-12 16:45:18 -07004613 * <p class="note"><strong>Note:</strong> Always call the super implementation before adding
4614 * information to the event, in case the default implementation has basic information to add.
4615 * </p>
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004616 *
4617 * @param event The accessibility event which to populate.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004618 *
4619 * @see #sendAccessibilityEvent(int)
4620 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004621 */
4622 public void onPopulateAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004623 if (mAccessibilityDelegate != null) {
4624 mAccessibilityDelegate.onPopulateAccessibilityEvent(this, event);
4625 } else {
4626 onPopulateAccessibilityEventInternal(event);
4627 }
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004628 }
4629
4630 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004631 * @see #onPopulateAccessibilityEvent(AccessibilityEvent)
4632 *
4633 * Note: Called from the default {@link AccessibilityDelegate}.
4634 */
4635 void onPopulateAccessibilityEventInternal(AccessibilityEvent event) {
4636
4637 }
4638
4639 /**
4640 * Initializes an {@link AccessibilityEvent} with information about
4641 * this View which is the event source. In other words, the source of
4642 * an accessibility event is the view whose state change triggered firing
4643 * the event.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004644 * <p>
4645 * Example: Setting the password property of an event in addition
Scott Mainb303d832011-10-12 16:45:18 -07004646 * to properties set by the super implementation:
4647 * <pre> public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
4648 * super.onInitializeAccessibilityEvent(event);
4649 * event.setPassword(true);
4650 * }</pre>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004651 * <p>
4652 * If an {@link AccessibilityDelegate} has been specified via calling
4653 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4654 * {@link AccessibilityDelegate#onInitializeAccessibilityEvent(View, AccessibilityEvent)}
4655 * is responsible for handling this call.
4656 * </p>
Scott Mainb303d832011-10-12 16:45:18 -07004657 * <p class="note"><strong>Note:</strong> Always call the super implementation before adding
4658 * information to the event, in case the default implementation has basic information to add.
4659 * </p>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004660 * @param event The event to initialize.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004661 *
4662 * @see #sendAccessibilityEvent(int)
4663 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
4664 */
4665 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004666 if (mAccessibilityDelegate != null) {
4667 mAccessibilityDelegate.onInitializeAccessibilityEvent(this, event);
4668 } else {
4669 onInitializeAccessibilityEventInternal(event);
4670 }
4671 }
4672
4673 /**
4674 * @see #onInitializeAccessibilityEvent(AccessibilityEvent)
4675 *
4676 * Note: Called from the default {@link AccessibilityDelegate}.
4677 */
4678 void onInitializeAccessibilityEventInternal(AccessibilityEvent event) {
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004679 event.setSource(this);
Svetoslav Ganov8a78fd42012-01-17 14:36:46 -08004680 event.setClassName(View.class.getName());
Svetoslav Ganov30401322011-05-12 18:53:45 -07004681 event.setPackageName(getContext().getPackageName());
4682 event.setEnabled(isEnabled());
4683 event.setContentDescription(mContentDescription);
4684
Svetoslav Ganovd9ee72f2011-10-05 22:26:05 -07004685 if (event.getEventType() == AccessibilityEvent.TYPE_VIEW_FOCUSED && mAttachInfo != null) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004686 ArrayList<View> focusablesTempList = mAttachInfo.mTempArrayList;
Svetoslav Ganovd9ee72f2011-10-05 22:26:05 -07004687 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD,
4688 FOCUSABLES_ALL);
4689 event.setItemCount(focusablesTempList.size());
4690 event.setCurrentItemIndex(focusablesTempList.indexOf(this));
4691 focusablesTempList.clear();
Svetoslav Ganov30401322011-05-12 18:53:45 -07004692 }
4693 }
4694
4695 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004696 * Returns an {@link AccessibilityNodeInfo} representing this view from the
4697 * point of view of an {@link android.accessibilityservice.AccessibilityService}.
4698 * This method is responsible for obtaining an accessibility node info from a
4699 * pool of reusable instances and calling
4700 * {@link #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} on this view to
4701 * initialize the former.
4702 * <p>
4703 * Note: The client is responsible for recycling the obtained instance by calling
4704 * {@link AccessibilityNodeInfo#recycle()} to minimize object creation.
4705 * </p>
Svetoslav Ganov02107852011-10-03 17:06:56 -07004706 *
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004707 * @return A populated {@link AccessibilityNodeInfo}.
4708 *
4709 * @see AccessibilityNodeInfo
4710 */
4711 public AccessibilityNodeInfo createAccessibilityNodeInfo() {
Svetoslav Ganov02107852011-10-03 17:06:56 -07004712 AccessibilityNodeProvider provider = getAccessibilityNodeProvider();
4713 if (provider != null) {
4714 return provider.createAccessibilityNodeInfo(View.NO_ID);
4715 } else {
4716 AccessibilityNodeInfo info = AccessibilityNodeInfo.obtain(this);
4717 onInitializeAccessibilityNodeInfo(info);
4718 return info;
4719 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004720 }
4721
4722 /**
4723 * Initializes an {@link AccessibilityNodeInfo} with information about this view.
4724 * The base implementation sets:
4725 * <ul>
4726 * <li>{@link AccessibilityNodeInfo#setParent(View)},</li>
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07004727 * <li>{@link AccessibilityNodeInfo#setBoundsInParent(Rect)},</li>
4728 * <li>{@link AccessibilityNodeInfo#setBoundsInScreen(Rect)},</li>
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004729 * <li>{@link AccessibilityNodeInfo#setPackageName(CharSequence)},</li>
4730 * <li>{@link AccessibilityNodeInfo#setClassName(CharSequence)},</li>
4731 * <li>{@link AccessibilityNodeInfo#setContentDescription(CharSequence)},</li>
4732 * <li>{@link AccessibilityNodeInfo#setEnabled(boolean)},</li>
4733 * <li>{@link AccessibilityNodeInfo#setClickable(boolean)},</li>
4734 * <li>{@link AccessibilityNodeInfo#setFocusable(boolean)},</li>
4735 * <li>{@link AccessibilityNodeInfo#setFocused(boolean)},</li>
4736 * <li>{@link AccessibilityNodeInfo#setLongClickable(boolean)},</li>
4737 * <li>{@link AccessibilityNodeInfo#setSelected(boolean)},</li>
4738 * </ul>
4739 * <p>
4740 * Subclasses should override this method, call the super implementation,
4741 * and set additional attributes.
4742 * </p>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004743 * <p>
4744 * If an {@link AccessibilityDelegate} has been specified via calling
4745 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4746 * {@link AccessibilityDelegate#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfo)}
4747 * is responsible for handling this call.
4748 * </p>
4749 *
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004750 * @param info The instance to initialize.
4751 */
4752 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004753 if (mAccessibilityDelegate != null) {
4754 mAccessibilityDelegate.onInitializeAccessibilityNodeInfo(this, info);
4755 } else {
4756 onInitializeAccessibilityNodeInfoInternal(info);
4757 }
4758 }
4759
4760 /**
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004761 * Gets the location of this view in screen coordintates.
4762 *
4763 * @param outRect The output location
4764 */
4765 private void getBoundsOnScreen(Rect outRect) {
4766 if (mAttachInfo == null) {
4767 return;
4768 }
4769
4770 RectF position = mAttachInfo.mTmpTransformRect;
Svetoslav Ganov14b2b742012-05-08 16:36:34 -07004771 position.set(0, 0, mRight - mLeft, mBottom - mTop);
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004772
4773 if (!hasIdentityMatrix()) {
4774 getMatrix().mapRect(position);
4775 }
4776
Svetoslav Ganov14b2b742012-05-08 16:36:34 -07004777 position.offset(mLeft, mTop);
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004778
4779 ViewParent parent = mParent;
4780 while (parent instanceof View) {
4781 View parentView = (View) parent;
4782
4783 position.offset(-parentView.mScrollX, -parentView.mScrollY);
4784
4785 if (!parentView.hasIdentityMatrix()) {
4786 parentView.getMatrix().mapRect(position);
4787 }
4788
4789 position.offset(parentView.mLeft, parentView.mTop);
4790
4791 parent = parentView.mParent;
4792 }
4793
4794 if (parent instanceof ViewRootImpl) {
4795 ViewRootImpl viewRootImpl = (ViewRootImpl) parent;
4796 position.offset(0, -viewRootImpl.mCurScrollY);
4797 }
4798
4799 position.offset(mAttachInfo.mWindowLeft, mAttachInfo.mWindowTop);
4800
4801 outRect.set((int) (position.left + 0.5f), (int) (position.top + 0.5f),
4802 (int) (position.right + 0.5f), (int) (position.bottom + 0.5f));
4803 }
4804
4805 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004806 * @see #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
4807 *
4808 * Note: Called from the default {@link AccessibilityDelegate}.
4809 */
4810 void onInitializeAccessibilityNodeInfoInternal(AccessibilityNodeInfo info) {
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004811 Rect bounds = mAttachInfo.mTmpInvalRect;
Svetoslav Ganov983119a2012-07-03 21:04:10 -07004812
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004813 getDrawingRect(bounds);
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07004814 info.setBoundsInParent(bounds);
4815
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004816 getBoundsOnScreen(bounds);
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07004817 info.setBoundsInScreen(bounds);
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004818
Svetoslav Ganovc406be92012-05-11 16:12:32 -07004819 ViewParent parent = getParentForAccessibility();
4820 if (parent instanceof View) {
4821 info.setParent((View) parent);
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004822 }
4823
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004824 info.setVisibleToUser(isVisibleToUser());
4825
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004826 info.setPackageName(mContext.getPackageName());
Svetoslav Ganov8a78fd42012-01-17 14:36:46 -08004827 info.setClassName(View.class.getName());
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004828 info.setContentDescription(getContentDescription());
4829
4830 info.setEnabled(isEnabled());
4831 info.setClickable(isClickable());
4832 info.setFocusable(isFocusable());
4833 info.setFocused(isFocused());
Svetoslav Ganov42138042012-03-20 11:51:39 -07004834 info.setAccessibilityFocused(isAccessibilityFocused());
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004835 info.setSelected(isSelected());
4836 info.setLongClickable(isLongClickable());
4837
4838 // TODO: These make sense only if we are in an AdapterView but all
4839 // views can be selected. Maybe from accessiiblity perspective
4840 // we should report as selectable view in an AdapterView.
4841 info.addAction(AccessibilityNodeInfo.ACTION_SELECT);
4842 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_SELECTION);
4843
4844 if (isFocusable()) {
4845 if (isFocused()) {
4846 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_FOCUS);
4847 } else {
4848 info.addAction(AccessibilityNodeInfo.ACTION_FOCUS);
4849 }
4850 }
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004851
Svetoslav Ganov02afe2c2012-05-07 17:51:59 -07004852 if (!isAccessibilityFocused()) {
Svetoslav Ganov27e2da72012-07-02 18:12:00 -07004853 info.addAction(AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS);
Svetoslav Ganov02afe2c2012-05-07 17:51:59 -07004854 } else {
4855 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS);
4856 }
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004857
Svetoslav Ganovfb1e80a2012-05-16 17:33:19 -07004858 if (isClickable() && isEnabled()) {
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004859 info.addAction(AccessibilityNodeInfo.ACTION_CLICK);
4860 }
4861
Svetoslav Ganovfb1e80a2012-05-16 17:33:19 -07004862 if (isLongClickable() && isEnabled()) {
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004863 info.addAction(AccessibilityNodeInfo.ACTION_LONG_CLICK);
4864 }
4865
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07004866 if (mContentDescription != null && mContentDescription.length() > 0) {
Svetoslav Ganov2b435aa2012-05-04 17:16:37 -07004867 info.addAction(AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY);
4868 info.addAction(AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY);
4869 info.setMovementGranularities(AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07004870 | AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD
4871 | AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH);
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004872 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004873 }
4874
4875 /**
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004876 * Computes whether this view is visible to the user. Such a view is
4877 * attached, visible, all its predecessors are visible, it is not clipped
4878 * entirely by its predecessors, and has an alpha greater than zero.
Svetoslav Ganov749e7962012-04-19 17:13:46 -07004879 *
4880 * @return Whether the view is visible on the screen.
Guang Zhu0d607fb2012-05-11 19:34:56 -07004881 *
4882 * @hide
Svetoslav Ganov749e7962012-04-19 17:13:46 -07004883 */
Guang Zhu0d607fb2012-05-11 19:34:56 -07004884 protected boolean isVisibleToUser() {
4885 return isVisibleToUser(null);
4886 }
4887
4888 /**
Romain Guyf0af1d52012-07-11 18:31:21 -07004889 * Computes whether the given portion of this view is visible to the user.
4890 * Such a view is attached, visible, all its predecessors are visible,
4891 * has an alpha greater than zero, and the specified portion is not
4892 * clipped entirely by its predecessors.
Guang Zhu0d607fb2012-05-11 19:34:56 -07004893 *
4894 * @param boundInView the portion of the view to test; coordinates should be relative; may be
4895 * <code>null</code>, and the entire view will be tested in this case.
4896 * When <code>true</code> is returned by the function, the actual visible
4897 * region will be stored in this parameter; that is, if boundInView is fully
4898 * contained within the view, no modification will be made, otherwise regions
4899 * outside of the visible area of the view will be clipped.
4900 *
4901 * @return Whether the specified portion of the view is visible on the screen.
4902 *
4903 * @hide
4904 */
4905 protected boolean isVisibleToUser(Rect boundInView) {
Romain Guyf0af1d52012-07-11 18:31:21 -07004906 if (mAttachInfo != null) {
4907 Rect visibleRect = mAttachInfo.mTmpInvalRect;
4908 Point offset = mAttachInfo.mPoint;
4909 // The first two checks are made also made by isShown() which
4910 // however traverses the tree up to the parent to catch that.
4911 // Therefore, we do some fail fast check to minimize the up
4912 // tree traversal.
4913 boolean isVisible = mAttachInfo.mWindowVisibility == View.VISIBLE
4914 && getAlpha() > 0
4915 && isShown()
4916 && getGlobalVisibleRect(visibleRect, offset);
Guang Zhu0d607fb2012-05-11 19:34:56 -07004917 if (isVisible && boundInView != null) {
4918 visibleRect.offset(-offset.x, -offset.y);
Romain Guyf0af1d52012-07-11 18:31:21 -07004919 // isVisible is always true here, use a simple assignment
4920 isVisible = boundInView.intersect(visibleRect);
Guang Zhu0d607fb2012-05-11 19:34:56 -07004921 }
4922 return isVisible;
Romain Guyf0af1d52012-07-11 18:31:21 -07004923 }
4924
4925 return false;
Svetoslav Ganov749e7962012-04-19 17:13:46 -07004926 }
4927
4928 /**
alanvb72fe7a2012-08-27 16:44:25 -07004929 * Returns the delegate for implementing accessibility support via
4930 * composition. For more details see {@link AccessibilityDelegate}.
4931 *
4932 * @return The delegate, or null if none set.
4933 *
4934 * @hide
4935 */
4936 public AccessibilityDelegate getAccessibilityDelegate() {
4937 return mAccessibilityDelegate;
4938 }
4939
4940 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004941 * Sets a delegate for implementing accessibility support via compositon as
4942 * opposed to inheritance. The delegate's primary use is for implementing
4943 * backwards compatible widgets. For more details see {@link AccessibilityDelegate}.
4944 *
4945 * @param delegate The delegate instance.
4946 *
4947 * @see AccessibilityDelegate
4948 */
4949 public void setAccessibilityDelegate(AccessibilityDelegate delegate) {
4950 mAccessibilityDelegate = delegate;
4951 }
4952
4953 /**
Svetoslav Ganov02107852011-10-03 17:06:56 -07004954 * Gets the provider for managing a virtual view hierarchy rooted at this View
4955 * and reported to {@link android.accessibilityservice.AccessibilityService}s
4956 * that explore the window content.
4957 * <p>
4958 * If this method returns an instance, this instance is responsible for managing
4959 * {@link AccessibilityNodeInfo}s describing the virtual sub-tree rooted at this
4960 * View including the one representing the View itself. Similarly the returned
4961 * instance is responsible for performing accessibility actions on any virtual
4962 * view or the root view itself.
4963 * </p>
4964 * <p>
4965 * If an {@link AccessibilityDelegate} has been specified via calling
4966 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4967 * {@link AccessibilityDelegate#getAccessibilityNodeProvider(View)}
4968 * is responsible for handling this call.
4969 * </p>
4970 *
4971 * @return The provider.
4972 *
4973 * @see AccessibilityNodeProvider
4974 */
4975 public AccessibilityNodeProvider getAccessibilityNodeProvider() {
4976 if (mAccessibilityDelegate != null) {
4977 return mAccessibilityDelegate.getAccessibilityNodeProvider(this);
4978 } else {
4979 return null;
4980 }
4981 }
4982
4983 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004984 * Gets the unique identifier of this view on the screen for accessibility purposes.
4985 * If this {@link View} is not attached to any window, {@value #NO_ID} is returned.
4986 *
4987 * @return The view accessibility id.
4988 *
4989 * @hide
4990 */
4991 public int getAccessibilityViewId() {
4992 if (mAccessibilityViewId == NO_ID) {
4993 mAccessibilityViewId = sNextAccessibilityViewId++;
4994 }
4995 return mAccessibilityViewId;
4996 }
4997
4998 /**
4999 * Gets the unique identifier of the window in which this View reseides.
5000 *
5001 * @return The window accessibility id.
5002 *
5003 * @hide
5004 */
5005 public int getAccessibilityWindowId() {
5006 return mAttachInfo != null ? mAttachInfo.mAccessibilityWindowId : NO_ID;
5007 }
5008
5009 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07005010 * Gets the {@link View} description. It briefly describes the view and is
5011 * primarily used for accessibility support. Set this property to enable
5012 * better accessibility support for your application. This is especially
5013 * true for views that do not have textual representation (For example,
5014 * ImageButton).
5015 *
Svetoslav Ganov42138042012-03-20 11:51:39 -07005016 * @return The content description.
svetoslavganov75986cf2009-05-14 22:28:01 -07005017 *
5018 * @attr ref android.R.styleable#View_contentDescription
5019 */
Svetoslav Ganov42138042012-03-20 11:51:39 -07005020 @ViewDebug.ExportedProperty(category = "accessibility")
svetoslavganov75986cf2009-05-14 22:28:01 -07005021 public CharSequence getContentDescription() {
5022 return mContentDescription;
5023 }
5024
5025 /**
5026 * Sets the {@link View} description. It briefly describes the view and is
5027 * primarily used for accessibility support. Set this property to enable
5028 * better accessibility support for your application. This is especially
5029 * true for views that do not have textual representation (For example,
5030 * ImageButton).
5031 *
5032 * @param contentDescription The content description.
5033 *
5034 * @attr ref android.R.styleable#View_contentDescription
5035 */
Svetoslav Ganove261e282011-10-18 17:47:04 -07005036 @RemotableViewMethod
svetoslavganov75986cf2009-05-14 22:28:01 -07005037 public void setContentDescription(CharSequence contentDescription) {
5038 mContentDescription = contentDescription;
Svetoslav Ganove47957a2012-06-05 14:46:50 -07005039 final boolean nonEmptyDesc = contentDescription != null && contentDescription.length() > 0;
5040 if (nonEmptyDesc && getImportantForAccessibility() == IMPORTANT_FOR_ACCESSIBILITY_AUTO) {
5041 setImportantForAccessibility(IMPORTANT_FOR_ACCESSIBILITY_YES);
5042 }
svetoslavganov75986cf2009-05-14 22:28:01 -07005043 }
5044
5045 /**
Romain Guya2431d02009-04-30 16:30:00 -07005046 * Invoked whenever this view loses focus, either by losing window focus or by losing
5047 * focus within its window. This method can be used to clear any state tied to the
5048 * focus. For instance, if a button is held pressed with the trackball and the window
5049 * loses focus, this method can be used to cancel the press.
5050 *
5051 * Subclasses of View overriding this method should always call super.onFocusLost().
5052 *
5053 * @see #onFocusChanged(boolean, int, android.graphics.Rect)
Romain Guy8506ab42009-06-11 17:35:47 -07005054 * @see #onWindowFocusChanged(boolean)
Romain Guya2431d02009-04-30 16:30:00 -07005055 *
5056 * @hide pending API council approval
5057 */
5058 protected void onFocusLost() {
5059 resetPressedState();
5060 }
5061
5062 private void resetPressedState() {
5063 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
5064 return;
5065 }
5066
5067 if (isPressed()) {
5068 setPressed(false);
5069
5070 if (!mHasPerformedLongPress) {
Maryam Garrett1549dd12009-12-15 16:06:36 -05005071 removeLongPressCallback();
Romain Guya2431d02009-04-30 16:30:00 -07005072 }
5073 }
5074 }
5075
5076 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005077 * Returns true if this view has focus
5078 *
5079 * @return True if this view has focus, false otherwise.
5080 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005081 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005082 public boolean isFocused() {
Dianne Hackborn4702a852012-08-17 15:18:29 -07005083 return (mPrivateFlags & PFLAG_FOCUSED) != 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005084 }
5085
5086 /**
5087 * Find the view in the hierarchy rooted at this view that currently has
5088 * focus.
5089 *
5090 * @return The view that currently has focus, or null if no focused view can
5091 * be found.
5092 */
5093 public View findFocus() {
Dianne Hackborn4702a852012-08-17 15:18:29 -07005094 return (mPrivateFlags & PFLAG_FOCUSED) != 0 ? this : null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005095 }
5096
5097 /**
Philip Milne6c8ea062012-04-03 17:38:43 -07005098 * Indicates whether this view is one of the set of scrollable containers in
5099 * its window.
5100 *
5101 * @return whether this view is one of the set of scrollable containers in
5102 * its window
5103 *
5104 * @attr ref android.R.styleable#View_isScrollContainer
5105 */
5106 public boolean isScrollContainer() {
Dianne Hackborn4702a852012-08-17 15:18:29 -07005107 return (mPrivateFlags & PFLAG_SCROLL_CONTAINER_ADDED) != 0;
Philip Milne6c8ea062012-04-03 17:38:43 -07005108 }
5109
5110 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005111 * Change whether this view is one of the set of scrollable containers in
5112 * its window. This will be used to determine whether the window can
5113 * resize or must pan when a soft input area is open -- scrollable
5114 * containers allow the window to use resize mode since the container
5115 * will appropriately shrink.
Philip Milne6c8ea062012-04-03 17:38:43 -07005116 *
5117 * @attr ref android.R.styleable#View_isScrollContainer
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005118 */
5119 public void setScrollContainer(boolean isScrollContainer) {
5120 if (isScrollContainer) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07005121 if (mAttachInfo != null && (mPrivateFlags&PFLAG_SCROLL_CONTAINER_ADDED) == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005122 mAttachInfo.mScrollContainers.add(this);
Dianne Hackborn4702a852012-08-17 15:18:29 -07005123 mPrivateFlags |= PFLAG_SCROLL_CONTAINER_ADDED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005124 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07005125 mPrivateFlags |= PFLAG_SCROLL_CONTAINER;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005126 } else {
Dianne Hackborn4702a852012-08-17 15:18:29 -07005127 if ((mPrivateFlags&PFLAG_SCROLL_CONTAINER_ADDED) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005128 mAttachInfo.mScrollContainers.remove(this);
5129 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07005130 mPrivateFlags &= ~(PFLAG_SCROLL_CONTAINER|PFLAG_SCROLL_CONTAINER_ADDED);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005131 }
5132 }
5133
5134 /**
5135 * Returns the quality of the drawing cache.
5136 *
5137 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO},
5138 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
5139 *
5140 * @see #setDrawingCacheQuality(int)
5141 * @see #setDrawingCacheEnabled(boolean)
5142 * @see #isDrawingCacheEnabled()
5143 *
5144 * @attr ref android.R.styleable#View_drawingCacheQuality
5145 */
5146 public int getDrawingCacheQuality() {
5147 return mViewFlags & DRAWING_CACHE_QUALITY_MASK;
5148 }
5149
5150 /**
5151 * Set the drawing cache quality of this view. This value is used only when the
5152 * drawing cache is enabled
5153 *
5154 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO},
5155 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
5156 *
5157 * @see #getDrawingCacheQuality()
5158 * @see #setDrawingCacheEnabled(boolean)
5159 * @see #isDrawingCacheEnabled()
5160 *
5161 * @attr ref android.R.styleable#View_drawingCacheQuality
5162 */
5163 public void setDrawingCacheQuality(int quality) {
5164 setFlags(quality, DRAWING_CACHE_QUALITY_MASK);
5165 }
5166
5167 /**
5168 * Returns whether the screen should remain on, corresponding to the current
5169 * value of {@link #KEEP_SCREEN_ON}.
5170 *
5171 * @return Returns true if {@link #KEEP_SCREEN_ON} is set.
5172 *
5173 * @see #setKeepScreenOn(boolean)
5174 *
5175 * @attr ref android.R.styleable#View_keepScreenOn
5176 */
5177 public boolean getKeepScreenOn() {
5178 return (mViewFlags & KEEP_SCREEN_ON) != 0;
5179 }
5180
5181 /**
5182 * Controls whether the screen should remain on, modifying the
5183 * value of {@link #KEEP_SCREEN_ON}.
5184 *
5185 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}.
5186 *
5187 * @see #getKeepScreenOn()
5188 *
5189 * @attr ref android.R.styleable#View_keepScreenOn
5190 */
5191 public void setKeepScreenOn(boolean keepScreenOn) {
5192 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON);
5193 }
5194
5195 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005196 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
5197 * @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 -08005198 *
5199 * @attr ref android.R.styleable#View_nextFocusLeft
5200 */
5201 public int getNextFocusLeftId() {
5202 return mNextFocusLeftId;
5203 }
5204
5205 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005206 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
5207 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should
5208 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005209 *
5210 * @attr ref android.R.styleable#View_nextFocusLeft
5211 */
5212 public void setNextFocusLeftId(int nextFocusLeftId) {
5213 mNextFocusLeftId = nextFocusLeftId;
5214 }
5215
5216 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005217 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
5218 * @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 -08005219 *
5220 * @attr ref android.R.styleable#View_nextFocusRight
5221 */
5222 public int getNextFocusRightId() {
5223 return mNextFocusRightId;
5224 }
5225
5226 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005227 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
5228 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should
5229 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005230 *
5231 * @attr ref android.R.styleable#View_nextFocusRight
5232 */
5233 public void setNextFocusRightId(int nextFocusRightId) {
5234 mNextFocusRightId = nextFocusRightId;
5235 }
5236
5237 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005238 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}.
5239 * @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 -08005240 *
5241 * @attr ref android.R.styleable#View_nextFocusUp
5242 */
5243 public int getNextFocusUpId() {
5244 return mNextFocusUpId;
5245 }
5246
5247 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005248 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}.
5249 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should
5250 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005251 *
5252 * @attr ref android.R.styleable#View_nextFocusUp
5253 */
5254 public void setNextFocusUpId(int nextFocusUpId) {
5255 mNextFocusUpId = nextFocusUpId;
5256 }
5257
5258 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005259 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
5260 * @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 -08005261 *
5262 * @attr ref android.R.styleable#View_nextFocusDown
5263 */
5264 public int getNextFocusDownId() {
5265 return mNextFocusDownId;
5266 }
5267
5268 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005269 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
5270 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should
5271 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005272 *
5273 * @attr ref android.R.styleable#View_nextFocusDown
5274 */
5275 public void setNextFocusDownId(int nextFocusDownId) {
5276 mNextFocusDownId = nextFocusDownId;
5277 }
5278
5279 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005280 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
5281 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
5282 *
5283 * @attr ref android.R.styleable#View_nextFocusForward
5284 */
5285 public int getNextFocusForwardId() {
5286 return mNextFocusForwardId;
5287 }
5288
5289 /**
5290 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
5291 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should
5292 * decide automatically.
5293 *
5294 * @attr ref android.R.styleable#View_nextFocusForward
5295 */
5296 public void setNextFocusForwardId(int nextFocusForwardId) {
5297 mNextFocusForwardId = nextFocusForwardId;
5298 }
5299
5300 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005301 * Returns the visibility of this view and all of its ancestors
5302 *
5303 * @return True if this view and all of its ancestors are {@link #VISIBLE}
5304 */
5305 public boolean isShown() {
5306 View current = this;
5307 //noinspection ConstantConditions
5308 do {
5309 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) {
5310 return false;
5311 }
5312 ViewParent parent = current.mParent;
5313 if (parent == null) {
5314 return false; // We are not attached to the view root
5315 }
5316 if (!(parent instanceof View)) {
5317 return true;
5318 }
5319 current = (View) parent;
5320 } while (current != null);
5321
5322 return false;
5323 }
5324
5325 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005326 * Called by the view hierarchy when the content insets for a window have
5327 * changed, to allow it to adjust its content to fit within those windows.
5328 * The content insets tell you the space that the status bar, input method,
5329 * and other system windows infringe on the application's window.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005330 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005331 * <p>You do not normally need to deal with this function, since the default
5332 * window decoration given to applications takes care of applying it to the
5333 * content of the window. If you use {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}
5334 * or {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION} this will not be the case,
5335 * and your content can be placed under those system elements. You can then
5336 * use this method within your view hierarchy if you have parts of your UI
5337 * which you would like to ensure are not being covered.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005338 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005339 * <p>The default implementation of this method simply applies the content
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005340 * inset's to the view's padding, consuming that content (modifying the
5341 * insets to be 0), and returning true. This behavior is off by default, but can
5342 * be enabled through {@link #setFitsSystemWindows(boolean)}.
5343 *
5344 * <p>This function's traversal down the hierarchy is depth-first. The same content
5345 * insets object is propagated down the hierarchy, so any changes made to it will
5346 * be seen by all following views (including potentially ones above in
5347 * the hierarchy since this is a depth-first traversal). The first view
5348 * that returns true will abort the entire traversal.
5349 *
5350 * <p>The default implementation works well for a situation where it is
5351 * used with a container that covers the entire window, allowing it to
5352 * apply the appropriate insets to its content on all edges. If you need
5353 * a more complicated layout (such as two different views fitting system
5354 * windows, one on the top of the window, and one on the bottom),
5355 * you can override the method and handle the insets however you would like.
5356 * Note that the insets provided by the framework are always relative to the
5357 * far edges of the window, not accounting for the location of the called view
5358 * within that window. (In fact when this method is called you do not yet know
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005359 * where the layout will place the view, as it is done before layout happens.)
5360 *
5361 * <p>Note: unlike many View methods, there is no dispatch phase to this
5362 * call. If you are overriding it in a ViewGroup and want to allow the
5363 * call to continue to your children, you must be sure to call the super
5364 * implementation.
5365 *
Dianne Hackborncf675782012-05-10 15:07:24 -07005366 * <p>Here is a sample layout that makes use of fitting system windows
5367 * to have controls for a video view placed inside of the window decorations
5368 * that it hides and shows. This can be used with code like the second
5369 * sample (video player) shown in {@link #setSystemUiVisibility(int)}.
5370 *
5371 * {@sample development/samples/ApiDemos/res/layout/video_player.xml complete}
5372 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005373 * @param insets Current content insets of the window. Prior to
5374 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN} you must not modify
5375 * the insets or else you and Android will be unhappy.
5376 *
5377 * @return Return true if this view applied the insets and it should not
5378 * continue propagating further down the hierarchy, false otherwise.
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005379 * @see #getFitsSystemWindows()
Romain Guyf0af1d52012-07-11 18:31:21 -07005380 * @see #setFitsSystemWindows(boolean)
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005381 * @see #setSystemUiVisibility(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005382 */
5383 protected boolean fitSystemWindows(Rect insets) {
5384 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) {
Fabrice Di Meglio016456e2012-07-17 20:35:48 -07005385 mUserPaddingStart = UNDEFINED_PADDING;
5386 mUserPaddingEnd = UNDEFINED_PADDING;
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005387 if ((mViewFlags & OPTIONAL_FITS_SYSTEM_WINDOWS) == 0
5388 || mAttachInfo == null
5389 || (mAttachInfo.mSystemUiVisibility & SYSTEM_UI_LAYOUT_FLAGS) == 0) {
5390 internalSetPadding(insets.left, insets.top, insets.right, insets.bottom);
5391 return true;
5392 } else {
5393 internalSetPadding(0, 0, 0, 0);
5394 return false;
5395 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005396 }
5397 return false;
5398 }
5399
5400 /**
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005401 * Sets whether or not this view should account for system screen decorations
5402 * such as the status bar and inset its content; that is, controlling whether
5403 * the default implementation of {@link #fitSystemWindows(Rect)} will be
5404 * executed. See that method for more details.
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005405 *
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005406 * <p>Note that if you are providing your own implementation of
5407 * {@link #fitSystemWindows(Rect)}, then there is no need to set this
5408 * flag to true -- your implementation will be overriding the default
5409 * implementation that checks this flag.
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005410 *
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005411 * @param fitSystemWindows If true, then the default implementation of
5412 * {@link #fitSystemWindows(Rect)} will be executed.
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005413 *
5414 * @attr ref android.R.styleable#View_fitsSystemWindows
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005415 * @see #getFitsSystemWindows()
5416 * @see #fitSystemWindows(Rect)
5417 * @see #setSystemUiVisibility(int)
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005418 */
5419 public void setFitsSystemWindows(boolean fitSystemWindows) {
5420 setFlags(fitSystemWindows ? FITS_SYSTEM_WINDOWS : 0, FITS_SYSTEM_WINDOWS);
5421 }
5422
5423 /**
Dianne Hackborncf675782012-05-10 15:07:24 -07005424 * Check for state of {@link #setFitsSystemWindows(boolean). If this method
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005425 * returns true, the default implementation of {@link #fitSystemWindows(Rect)}
5426 * will be executed.
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005427 *
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005428 * @return Returns true if the default implementation of
5429 * {@link #fitSystemWindows(Rect)} will be executed.
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005430 *
5431 * @attr ref android.R.styleable#View_fitsSystemWindows
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005432 * @see #setFitsSystemWindows()
5433 * @see #fitSystemWindows(Rect)
5434 * @see #setSystemUiVisibility(int)
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005435 */
Dianne Hackborncf675782012-05-10 15:07:24 -07005436 public boolean getFitsSystemWindows() {
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005437 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS;
5438 }
5439
Dianne Hackbornb1b55e62012-05-10 16:25:54 -07005440 /** @hide */
5441 public boolean fitsSystemWindows() {
5442 return getFitsSystemWindows();
5443 }
5444
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005445 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005446 * Ask that a new dispatch of {@link #fitSystemWindows(Rect)} be performed.
5447 */
5448 public void requestFitSystemWindows() {
5449 if (mParent != null) {
5450 mParent.requestFitSystemWindows();
5451 }
5452 }
5453
5454 /**
5455 * For use by PhoneWindow to make its own system window fitting optional.
5456 * @hide
5457 */
5458 public void makeOptionalFitsSystemWindows() {
5459 setFlags(OPTIONAL_FITS_SYSTEM_WINDOWS, OPTIONAL_FITS_SYSTEM_WINDOWS);
5460 }
5461
5462 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005463 * Returns the visibility status for this view.
5464 *
5465 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
5466 * @attr ref android.R.styleable#View_visibility
5467 */
5468 @ViewDebug.ExportedProperty(mapping = {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07005469 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"),
5470 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"),
5471 @ViewDebug.IntToString(from = GONE, to = "GONE")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005472 })
5473 public int getVisibility() {
5474 return mViewFlags & VISIBILITY_MASK;
5475 }
5476
5477 /**
5478 * Set the enabled state of this view.
5479 *
5480 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
5481 * @attr ref android.R.styleable#View_visibility
5482 */
5483 @RemotableViewMethod
5484 public void setVisibility(int visibility) {
5485 setFlags(visibility, VISIBILITY_MASK);
Philip Milne6c8ea062012-04-03 17:38:43 -07005486 if (mBackground != null) mBackground.setVisible(visibility == VISIBLE, false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005487 }
5488
5489 /**
5490 * Returns the enabled status for this view. The interpretation of the
5491 * enabled state varies by subclass.
5492 *
5493 * @return True if this view is enabled, false otherwise.
5494 */
5495 @ViewDebug.ExportedProperty
5496 public boolean isEnabled() {
5497 return (mViewFlags & ENABLED_MASK) == ENABLED;
5498 }
5499
5500 /**
5501 * Set the enabled state of this view. The interpretation of the enabled
5502 * state varies by subclass.
5503 *
5504 * @param enabled True if this view is enabled, false otherwise.
5505 */
Jeff Sharkey2b95c242010-02-08 17:40:30 -08005506 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005507 public void setEnabled(boolean enabled) {
Amith Yamasania2ef00b2009-07-30 16:14:34 -07005508 if (enabled == isEnabled()) return;
5509
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005510 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK);
5511
5512 /*
5513 * The View most likely has to change its appearance, so refresh
5514 * the drawable state.
5515 */
5516 refreshDrawableState();
5517
5518 // Invalidate too, since the default behavior for views is to be
5519 // be drawn at 50% alpha rather than to change the drawable.
Romain Guy0fd89bf2011-01-26 15:41:30 -08005520 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005521 }
5522
5523 /**
5524 * Set whether this view can receive the focus.
5525 *
5526 * Setting this to false will also ensure that this view is not focusable
5527 * in touch mode.
5528 *
5529 * @param focusable If true, this view can receive the focus.
5530 *
5531 * @see #setFocusableInTouchMode(boolean)
5532 * @attr ref android.R.styleable#View_focusable
5533 */
5534 public void setFocusable(boolean focusable) {
5535 if (!focusable) {
5536 setFlags(0, FOCUSABLE_IN_TOUCH_MODE);
5537 }
5538 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK);
5539 }
5540
5541 /**
5542 * Set whether this view can receive focus while in touch mode.
5543 *
5544 * Setting this to true will also ensure that this view is focusable.
5545 *
5546 * @param focusableInTouchMode If true, this view can receive the focus while
5547 * in touch mode.
5548 *
5549 * @see #setFocusable(boolean)
5550 * @attr ref android.R.styleable#View_focusableInTouchMode
5551 */
5552 public void setFocusableInTouchMode(boolean focusableInTouchMode) {
5553 // Focusable in touch mode should always be set before the focusable flag
5554 // otherwise, setting the focusable flag will trigger a focusableViewAvailable()
5555 // which, in touch mode, will not successfully request focus on this view
5556 // because the focusable in touch mode flag is not set
5557 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE);
5558 if (focusableInTouchMode) {
5559 setFlags(FOCUSABLE, FOCUSABLE_MASK);
5560 }
5561 }
5562
5563 /**
5564 * Set whether this view should have sound effects enabled for events such as
5565 * clicking and touching.
5566 *
5567 * <p>You may wish to disable sound effects for a view if you already play sounds,
5568 * for instance, a dial key that plays dtmf tones.
5569 *
5570 * @param soundEffectsEnabled whether sound effects are enabled for this view.
5571 * @see #isSoundEffectsEnabled()
5572 * @see #playSoundEffect(int)
5573 * @attr ref android.R.styleable#View_soundEffectsEnabled
5574 */
5575 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) {
5576 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED);
5577 }
5578
5579 /**
5580 * @return whether this view should have sound effects enabled for events such as
5581 * clicking and touching.
5582 *
5583 * @see #setSoundEffectsEnabled(boolean)
5584 * @see #playSoundEffect(int)
5585 * @attr ref android.R.styleable#View_soundEffectsEnabled
5586 */
5587 @ViewDebug.ExportedProperty
5588 public boolean isSoundEffectsEnabled() {
5589 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED);
5590 }
5591
5592 /**
5593 * Set whether this view should have haptic feedback for events such as
5594 * long presses.
5595 *
5596 * <p>You may wish to disable haptic feedback if your view already controls
5597 * its own haptic feedback.
5598 *
5599 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view.
5600 * @see #isHapticFeedbackEnabled()
5601 * @see #performHapticFeedback(int)
5602 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
5603 */
5604 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) {
5605 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED);
5606 }
5607
5608 /**
5609 * @return whether this view should have haptic feedback enabled for events
5610 * long presses.
5611 *
5612 * @see #setHapticFeedbackEnabled(boolean)
5613 * @see #performHapticFeedback(int)
5614 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
5615 */
5616 @ViewDebug.ExportedProperty
5617 public boolean isHapticFeedbackEnabled() {
5618 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED);
5619 }
5620
5621 /**
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005622 * Returns the layout direction for this view.
Cibu Johny7632cb92010-02-22 13:01:02 -08005623 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005624 * @return One of {@link #LAYOUT_DIRECTION_LTR},
5625 * {@link #LAYOUT_DIRECTION_RTL},
5626 * {@link #LAYOUT_DIRECTION_INHERIT} or
5627 * {@link #LAYOUT_DIRECTION_LOCALE}.
5628 * @attr ref android.R.styleable#View_layoutDirection
Cibu Johny7632cb92010-02-22 13:01:02 -08005629 */
Fabrice Di Megliobce84d22011-06-02 15:57:01 -07005630 @ViewDebug.ExportedProperty(category = "layout", mapping = {
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005631 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "LTR"),
5632 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RTL"),
5633 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_INHERIT, to = "INHERIT"),
5634 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LOCALE, to = "LOCALE")
Cibu Johny7632cb92010-02-22 13:01:02 -08005635 })
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005636 public int getLayoutDirection() {
Dianne Hackborn4702a852012-08-17 15:18:29 -07005637 return (mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_MASK) >> PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT;
Cibu Johny7632cb92010-02-22 13:01:02 -08005638 }
5639
5640 /**
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005641 * Set the layout direction for this view. This will propagate a reset of layout direction
5642 * resolution to the view's children and resolve layout direction for this view.
Cibu Johny7632cb92010-02-22 13:01:02 -08005643 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005644 * @param layoutDirection One of {@link #LAYOUT_DIRECTION_LTR},
5645 * {@link #LAYOUT_DIRECTION_RTL},
5646 * {@link #LAYOUT_DIRECTION_INHERIT} or
5647 * {@link #LAYOUT_DIRECTION_LOCALE}.
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005648 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005649 * @attr ref android.R.styleable#View_layoutDirection
Cibu Johny7632cb92010-02-22 13:01:02 -08005650 */
5651 @RemotableViewMethod
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005652 public void setLayoutDirection(int layoutDirection) {
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005653 if (getLayoutDirection() != layoutDirection) {
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -07005654 // Reset the current layout direction and the resolved one
Dianne Hackborn4702a852012-08-17 15:18:29 -07005655 mPrivateFlags2 &= ~PFLAG2_LAYOUT_DIRECTION_MASK;
Fabrice Di Meglio7f86c802011-07-01 15:09:24 -07005656 resetResolvedLayoutDirection();
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07005657 // Reset padding resolution
Dianne Hackborn4702a852012-08-17 15:18:29 -07005658 mPrivateFlags2 &= ~PFLAG2_PADDING_RESOLVED;
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07005659 // Set the new layout direction (filtered)
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005660 mPrivateFlags2 |=
Dianne Hackborn4702a852012-08-17 15:18:29 -07005661 ((layoutDirection << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT) & PFLAG2_LAYOUT_DIRECTION_MASK);
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07005662 resolveRtlProperties();
5663 // ... and ask for a layout pass
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005664 requestLayout();
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005665 }
Cibu Johny7632cb92010-02-22 13:01:02 -08005666 }
5667
5668 /**
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005669 * Returns the resolved layout direction for this view.
5670 *
5671 * @return {@link #LAYOUT_DIRECTION_RTL} if the layout direction is RTL or returns
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005672 * {@link #LAYOUT_DIRECTION_LTR} if the layout direction is not RTL.
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005673 */
5674 @ViewDebug.ExportedProperty(category = "layout", mapping = {
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005675 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "RESOLVED_DIRECTION_LTR"),
5676 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RESOLVED_DIRECTION_RTL")
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005677 })
5678 public int getResolvedLayoutDirection() {
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07005679 final int targetSdkVersion = getContext().getApplicationInfo().targetSdkVersion;
5680 if (targetSdkVersion < JELLY_BEAN_MR1) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07005681 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED;
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07005682 return LAYOUT_DIRECTION_LTR;
5683 }
Fabrice Di Megliob93911f2012-06-26 19:43:15 -07005684 // The layout direction will be resolved only if needed
Dianne Hackborn4702a852012-08-17 15:18:29 -07005685 if ((mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_RESOLVED) != PFLAG2_LAYOUT_DIRECTION_RESOLVED) {
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -07005686 resolveLayoutDirection();
5687 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07005688 return ((mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL) == PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL) ?
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005689 LAYOUT_DIRECTION_RTL : LAYOUT_DIRECTION_LTR;
5690 }
5691
5692 /**
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005693 * Indicates whether or not this view's layout is right-to-left. This is resolved from
5694 * layout attribute and/or the inherited value from the parent
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005695 *
5696 * @return true if the layout is right-to-left.
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005697 */
5698 @ViewDebug.ExportedProperty(category = "layout")
5699 public boolean isLayoutRtl() {
5700 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL);
5701 }
5702
5703 /**
Adam Powell539ee872012-02-03 19:00:49 -08005704 * Indicates whether the view is currently tracking transient state that the
5705 * app should not need to concern itself with saving and restoring, but that
5706 * the framework should take special note to preserve when possible.
5707 *
Adam Powell785c4472012-05-02 21:25:39 -07005708 * <p>A view with transient state cannot be trivially rebound from an external
5709 * data source, such as an adapter binding item views in a list. This may be
5710 * because the view is performing an animation, tracking user selection
5711 * of content, or similar.</p>
5712 *
Adam Powell539ee872012-02-03 19:00:49 -08005713 * @return true if the view has transient state
Adam Powell539ee872012-02-03 19:00:49 -08005714 */
5715 @ViewDebug.ExportedProperty(category = "layout")
5716 public boolean hasTransientState() {
Dianne Hackborn4702a852012-08-17 15:18:29 -07005717 return (mPrivateFlags2 & PFLAG2_HAS_TRANSIENT_STATE) == PFLAG2_HAS_TRANSIENT_STATE;
Adam Powell539ee872012-02-03 19:00:49 -08005718 }
5719
5720 /**
5721 * Set whether this view is currently tracking transient state that the
Chet Haase563d4f22012-04-18 16:20:08 -07005722 * framework should attempt to preserve when possible. This flag is reference counted,
5723 * so every call to setHasTransientState(true) should be paired with a later call
5724 * to setHasTransientState(false).
Adam Powell539ee872012-02-03 19:00:49 -08005725 *
Adam Powell785c4472012-05-02 21:25:39 -07005726 * <p>A view with transient state cannot be trivially rebound from an external
5727 * data source, such as an adapter binding item views in a list. This may be
5728 * because the view is performing an animation, tracking user selection
5729 * of content, or similar.</p>
5730 *
Adam Powell539ee872012-02-03 19:00:49 -08005731 * @param hasTransientState true if this view has transient state
Adam Powell539ee872012-02-03 19:00:49 -08005732 */
5733 public void setHasTransientState(boolean hasTransientState) {
Chet Haase563d4f22012-04-18 16:20:08 -07005734 mTransientStateCount = hasTransientState ? mTransientStateCount + 1 :
5735 mTransientStateCount - 1;
5736 if (mTransientStateCount < 0) {
5737 mTransientStateCount = 0;
5738 Log.e(VIEW_LOG_TAG, "hasTransientState decremented below 0: " +
5739 "unmatched pair of setHasTransientState calls");
5740 }
5741 if ((hasTransientState && mTransientStateCount == 1) ||
Adam Powell057a5852012-05-11 10:28:38 -07005742 (!hasTransientState && mTransientStateCount == 0)) {
Chet Haase563d4f22012-04-18 16:20:08 -07005743 // update flag if we've just incremented up from 0 or decremented down to 0
Dianne Hackborn4702a852012-08-17 15:18:29 -07005744 mPrivateFlags2 = (mPrivateFlags2 & ~PFLAG2_HAS_TRANSIENT_STATE) |
5745 (hasTransientState ? PFLAG2_HAS_TRANSIENT_STATE : 0);
Chet Haase563d4f22012-04-18 16:20:08 -07005746 if (mParent != null) {
5747 try {
5748 mParent.childHasTransientStateChanged(this, hasTransientState);
5749 } catch (AbstractMethodError e) {
5750 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() +
5751 " does not fully implement ViewParent", e);
5752 }
Adam Powell539ee872012-02-03 19:00:49 -08005753 }
5754 }
5755 }
5756
5757 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005758 * If this view doesn't do any drawing on its own, set this flag to
5759 * allow further optimizations. By default, this flag is not set on
5760 * View, but could be set on some View subclasses such as ViewGroup.
5761 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07005762 * Typically, if you override {@link #onDraw(android.graphics.Canvas)}
5763 * you should clear this flag.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005764 *
5765 * @param willNotDraw whether or not this View draw on its own
5766 */
5767 public void setWillNotDraw(boolean willNotDraw) {
5768 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK);
5769 }
5770
5771 /**
5772 * Returns whether or not this View draws on its own.
5773 *
5774 * @return true if this view has nothing to draw, false otherwise
5775 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005776 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005777 public boolean willNotDraw() {
5778 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW;
5779 }
5780
5781 /**
5782 * When a View's drawing cache is enabled, drawing is redirected to an
5783 * offscreen bitmap. Some views, like an ImageView, must be able to
5784 * bypass this mechanism if they already draw a single bitmap, to avoid
5785 * unnecessary usage of the memory.
5786 *
5787 * @param willNotCacheDrawing true if this view does not cache its
5788 * drawing, false otherwise
5789 */
5790 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) {
5791 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING);
5792 }
5793
5794 /**
5795 * Returns whether or not this View can cache its drawing or not.
5796 *
5797 * @return true if this view does not cache its drawing, false otherwise
5798 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005799 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005800 public boolean willNotCacheDrawing() {
5801 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING;
5802 }
5803
5804 /**
5805 * Indicates whether this view reacts to click events or not.
5806 *
5807 * @return true if the view is clickable, false otherwise
5808 *
5809 * @see #setClickable(boolean)
5810 * @attr ref android.R.styleable#View_clickable
5811 */
5812 @ViewDebug.ExportedProperty
5813 public boolean isClickable() {
5814 return (mViewFlags & CLICKABLE) == CLICKABLE;
5815 }
5816
5817 /**
5818 * Enables or disables click events for this view. When a view
5819 * is clickable it will change its state to "pressed" on every click.
5820 * Subclasses should set the view clickable to visually react to
5821 * user's clicks.
5822 *
5823 * @param clickable true to make the view clickable, false otherwise
5824 *
5825 * @see #isClickable()
5826 * @attr ref android.R.styleable#View_clickable
5827 */
5828 public void setClickable(boolean clickable) {
5829 setFlags(clickable ? CLICKABLE : 0, CLICKABLE);
5830 }
5831
5832 /**
5833 * Indicates whether this view reacts to long click events or not.
5834 *
5835 * @return true if the view is long clickable, false otherwise
5836 *
5837 * @see #setLongClickable(boolean)
5838 * @attr ref android.R.styleable#View_longClickable
5839 */
5840 public boolean isLongClickable() {
5841 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
5842 }
5843
5844 /**
5845 * Enables or disables long click events for this view. When a view is long
5846 * clickable it reacts to the user holding down the button for a longer
5847 * duration than a tap. This event can either launch the listener or a
5848 * context menu.
5849 *
5850 * @param longClickable true to make the view long clickable, false otherwise
5851 * @see #isLongClickable()
5852 * @attr ref android.R.styleable#View_longClickable
5853 */
5854 public void setLongClickable(boolean longClickable) {
5855 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE);
5856 }
5857
5858 /**
Chet Haase49afa5b2010-08-23 11:39:53 -07005859 * Sets the pressed state for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005860 *
5861 * @see #isClickable()
5862 * @see #setClickable(boolean)
5863 *
5864 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts
5865 * the View's internal state from a previously set "pressed" state.
5866 */
5867 public void setPressed(boolean pressed) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07005868 final boolean needsRefresh = pressed != ((mPrivateFlags & PFLAG_PRESSED) == PFLAG_PRESSED);
Adam Powell4d6f0662012-02-21 15:11:11 -08005869
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005870 if (pressed) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07005871 mPrivateFlags |= PFLAG_PRESSED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005872 } else {
Dianne Hackborn4702a852012-08-17 15:18:29 -07005873 mPrivateFlags &= ~PFLAG_PRESSED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005874 }
Adam Powell035a1fc2012-02-27 15:23:50 -08005875
5876 if (needsRefresh) {
5877 refreshDrawableState();
5878 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005879 dispatchSetPressed(pressed);
5880 }
5881
5882 /**
5883 * Dispatch setPressed to all of this View's children.
5884 *
5885 * @see #setPressed(boolean)
5886 *
5887 * @param pressed The new pressed state
5888 */
5889 protected void dispatchSetPressed(boolean pressed) {
5890 }
5891
5892 /**
5893 * Indicates whether the view is currently in pressed state. Unless
5894 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter
5895 * the pressed state.
5896 *
Philip Milne6c8ea062012-04-03 17:38:43 -07005897 * @see #setPressed(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005898 * @see #isClickable()
5899 * @see #setClickable(boolean)
5900 *
5901 * @return true if the view is currently pressed, false otherwise
5902 */
5903 public boolean isPressed() {
Dianne Hackborn4702a852012-08-17 15:18:29 -07005904 return (mPrivateFlags & PFLAG_PRESSED) == PFLAG_PRESSED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005905 }
5906
5907 /**
5908 * Indicates whether this view will save its state (that is,
5909 * whether its {@link #onSaveInstanceState} method will be called).
5910 *
5911 * @return Returns true if the view state saving is enabled, else false.
5912 *
5913 * @see #setSaveEnabled(boolean)
5914 * @attr ref android.R.styleable#View_saveEnabled
5915 */
5916 public boolean isSaveEnabled() {
5917 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED;
5918 }
5919
5920 /**
5921 * Controls whether the saving of this view's state is
5922 * enabled (that is, whether its {@link #onSaveInstanceState} method
5923 * will be called). Note that even if freezing is enabled, the
Romain Guy5c22a8c2011-05-13 11:48:45 -07005924 * view still must have an id assigned to it (via {@link #setId(int)})
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005925 * for its state to be saved. This flag can only disable the
5926 * saving of this view; any child views may still have their state saved.
5927 *
5928 * @param enabled Set to false to <em>disable</em> state saving, or true
5929 * (the default) to allow it.
5930 *
5931 * @see #isSaveEnabled()
5932 * @see #setId(int)
5933 * @see #onSaveInstanceState()
5934 * @attr ref android.R.styleable#View_saveEnabled
5935 */
5936 public void setSaveEnabled(boolean enabled) {
5937 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK);
5938 }
5939
Jeff Brown85a31762010-09-01 17:01:00 -07005940 /**
5941 * Gets whether the framework should discard touches when the view's
5942 * window is obscured by another visible window.
5943 * Refer to the {@link View} security documentation for more details.
5944 *
5945 * @return True if touch filtering is enabled.
5946 *
5947 * @see #setFilterTouchesWhenObscured(boolean)
5948 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
5949 */
5950 @ViewDebug.ExportedProperty
5951 public boolean getFilterTouchesWhenObscured() {
5952 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0;
5953 }
5954
5955 /**
5956 * Sets whether the framework should discard touches when the view's
5957 * window is obscured by another visible window.
5958 * Refer to the {@link View} security documentation for more details.
5959 *
5960 * @param enabled True if touch filtering should be enabled.
5961 *
5962 * @see #getFilterTouchesWhenObscured
5963 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
5964 */
5965 public void setFilterTouchesWhenObscured(boolean enabled) {
5966 setFlags(enabled ? 0 : FILTER_TOUCHES_WHEN_OBSCURED,
5967 FILTER_TOUCHES_WHEN_OBSCURED);
5968 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005969
5970 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07005971 * Indicates whether the entire hierarchy under this view will save its
5972 * state when a state saving traversal occurs from its parent. The default
5973 * is true; if false, these views will not be saved unless
5974 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
5975 *
5976 * @return Returns true if the view state saving from parent is enabled, else false.
5977 *
5978 * @see #setSaveFromParentEnabled(boolean)
5979 */
5980 public boolean isSaveFromParentEnabled() {
5981 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED;
5982 }
5983
5984 /**
5985 * Controls whether the entire hierarchy under this view will save its
5986 * state when a state saving traversal occurs from its parent. The default
5987 * is true; if false, these views will not be saved unless
5988 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
5989 *
5990 * @param enabled Set to false to <em>disable</em> state saving, or true
5991 * (the default) to allow it.
5992 *
5993 * @see #isSaveFromParentEnabled()
5994 * @see #setId(int)
5995 * @see #onSaveInstanceState()
5996 */
5997 public void setSaveFromParentEnabled(boolean enabled) {
5998 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK);
5999 }
6000
6001
6002 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006003 * Returns whether this View is able to take focus.
6004 *
6005 * @return True if this view can take focus, or false otherwise.
6006 * @attr ref android.R.styleable#View_focusable
6007 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07006008 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006009 public final boolean isFocusable() {
6010 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK);
6011 }
6012
6013 /**
6014 * When a view is focusable, it may not want to take focus when in touch mode.
6015 * For example, a button would like focus when the user is navigating via a D-pad
6016 * so that the user can click on it, but once the user starts touching the screen,
6017 * the button shouldn't take focus
6018 * @return Whether the view is focusable in touch mode.
6019 * @attr ref android.R.styleable#View_focusableInTouchMode
6020 */
6021 @ViewDebug.ExportedProperty
6022 public final boolean isFocusableInTouchMode() {
6023 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE);
6024 }
6025
6026 /**
6027 * Find the nearest view in the specified direction that can take focus.
6028 * This does not actually give focus to that view.
6029 *
6030 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
6031 *
6032 * @return The nearest focusable in the specified direction, or null if none
6033 * can be found.
6034 */
6035 public View focusSearch(int direction) {
6036 if (mParent != null) {
6037 return mParent.focusSearch(this, direction);
6038 } else {
6039 return null;
6040 }
6041 }
6042
6043 /**
6044 * This method is the last chance for the focused view and its ancestors to
6045 * respond to an arrow key. This is called when the focused view did not
6046 * consume the key internally, nor could the view system find a new view in
6047 * the requested direction to give focus to.
6048 *
6049 * @param focused The currently focused view.
6050 * @param direction The direction focus wants to move. One of FOCUS_UP,
6051 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT.
6052 * @return True if the this view consumed this unhandled move.
6053 */
6054 public boolean dispatchUnhandledMove(View focused, int direction) {
6055 return false;
6056 }
6057
6058 /**
6059 * If a user manually specified the next view id for a particular direction,
Jeff Brown4e6319b2010-12-13 10:36:51 -08006060 * use the root to look up the view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006061 * @param root The root view of the hierarchy containing this view.
Jeff Brown4e6319b2010-12-13 10:36:51 -08006062 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD,
6063 * or FOCUS_BACKWARD.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006064 * @return The user specified next view, or null if there is none.
6065 */
6066 View findUserSetNextFocus(View root, int direction) {
6067 switch (direction) {
6068 case FOCUS_LEFT:
6069 if (mNextFocusLeftId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07006070 return findViewInsideOutShouldExist(root, mNextFocusLeftId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006071 case FOCUS_RIGHT:
6072 if (mNextFocusRightId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07006073 return findViewInsideOutShouldExist(root, mNextFocusRightId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006074 case FOCUS_UP:
6075 if (mNextFocusUpId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07006076 return findViewInsideOutShouldExist(root, mNextFocusUpId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006077 case FOCUS_DOWN:
6078 if (mNextFocusDownId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07006079 return findViewInsideOutShouldExist(root, mNextFocusDownId);
Jeff Brown4e6319b2010-12-13 10:36:51 -08006080 case FOCUS_FORWARD:
6081 if (mNextFocusForwardId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07006082 return findViewInsideOutShouldExist(root, mNextFocusForwardId);
Jeff Brown4e6319b2010-12-13 10:36:51 -08006083 case FOCUS_BACKWARD: {
John Reck1ecebbb2012-03-06 16:08:54 -08006084 if (mID == View.NO_ID) return null;
Jeff Brown4e6319b2010-12-13 10:36:51 -08006085 final int id = mID;
Jeff Brown4dfbec22011-08-15 14:55:37 -07006086 return root.findViewByPredicateInsideOut(this, new Predicate<View>() {
Jeff Brown4e6319b2010-12-13 10:36:51 -08006087 @Override
6088 public boolean apply(View t) {
6089 return t.mNextFocusForwardId == id;
6090 }
6091 });
6092 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006093 }
6094 return null;
6095 }
6096
Jeff Brown4dfbec22011-08-15 14:55:37 -07006097 private View findViewInsideOutShouldExist(View root, final int childViewId) {
6098 View result = root.findViewByPredicateInsideOut(this, new Predicate<View>() {
6099 @Override
6100 public boolean apply(View t) {
6101 return t.mID == childViewId;
6102 }
6103 });
6104
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006105 if (result == null) {
6106 Log.w(VIEW_LOG_TAG, "couldn't find next focus view specified "
6107 + "by user for id " + childViewId);
6108 }
6109 return result;
6110 }
6111
6112 /**
6113 * Find and return all focusable views that are descendants of this view,
6114 * possibly including this view if it is focusable itself.
6115 *
6116 * @param direction The direction of the focus
6117 * @return A list of focusable views
6118 */
6119 public ArrayList<View> getFocusables(int direction) {
6120 ArrayList<View> result = new ArrayList<View>(24);
6121 addFocusables(result, direction);
6122 return result;
6123 }
6124
6125 /**
6126 * Add any focusable views that are descendants of this view (possibly
6127 * including this view if it is focusable itself) to views. If we are in touch mode,
6128 * only add views that are also focusable in touch mode.
6129 *
6130 * @param views Focusable views found so far
6131 * @param direction The direction of the focus
6132 */
6133 public void addFocusables(ArrayList<View> views, int direction) {
svetoslavganov75986cf2009-05-14 22:28:01 -07006134 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE);
6135 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006136
svetoslavganov75986cf2009-05-14 22:28:01 -07006137 /**
6138 * Adds any focusable views that are descendants of this view (possibly
6139 * including this view if it is focusable itself) to views. This method
6140 * adds all focusable views regardless if we are in touch mode or
Svetoslav Ganov42138042012-03-20 11:51:39 -07006141 * only views focusable in touch mode if we are in touch mode or
6142 * only views that can take accessibility focus if accessibility is enabeld
6143 * depending on the focusable mode paramater.
svetoslavganov75986cf2009-05-14 22:28:01 -07006144 *
6145 * @param views Focusable views found so far or null if all we are interested is
6146 * the number of focusables.
6147 * @param direction The direction of the focus.
6148 * @param focusableMode The type of focusables to be added.
6149 *
6150 * @see #FOCUSABLES_ALL
6151 * @see #FOCUSABLES_TOUCH_MODE
6152 */
6153 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006154 if (views == null) {
svetoslavganov75986cf2009-05-14 22:28:01 -07006155 return;
6156 }
Svetoslav Ganov3cb889c2012-04-16 19:10:30 -07006157 if (!isFocusable()) {
6158 return;
svetoslavganov75986cf2009-05-14 22:28:01 -07006159 }
Svetoslav Ganov3cb889c2012-04-16 19:10:30 -07006160 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE
6161 && isInTouchMode() && !isFocusableInTouchMode()) {
6162 return;
6163 }
6164 views.add(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006165 }
6166
6167 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006168 * Finds the Views that contain given text. The containment is case insensitive.
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006169 * The search is performed by either the text that the View renders or the content
6170 * description that describes the view for accessibility purposes and the view does
6171 * not render or both. Clients can specify how the search is to be performed via
6172 * passing the {@link #FIND_VIEWS_WITH_TEXT} and
6173 * {@link #FIND_VIEWS_WITH_CONTENT_DESCRIPTION} flags.
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006174 *
6175 * @param outViews The output list of matching Views.
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006176 * @param searched The text to match against.
Svetoslav Ganov02107852011-10-03 17:06:56 -07006177 *
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006178 * @see #FIND_VIEWS_WITH_TEXT
6179 * @see #FIND_VIEWS_WITH_CONTENT_DESCRIPTION
6180 * @see #setContentDescription(CharSequence)
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006181 */
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006182 public void findViewsWithText(ArrayList<View> outViews, CharSequence searched, int flags) {
Svetoslav Ganov02107852011-10-03 17:06:56 -07006183 if (getAccessibilityNodeProvider() != null) {
6184 if ((flags & FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS) != 0) {
6185 outViews.add(this);
6186 }
6187 } else if ((flags & FIND_VIEWS_WITH_CONTENT_DESCRIPTION) != 0
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006188 && (searched != null && searched.length() > 0)
6189 && (mContentDescription != null && mContentDescription.length() > 0)) {
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006190 String searchedLowerCase = searched.toString().toLowerCase();
6191 String contentDescriptionLowerCase = mContentDescription.toString().toLowerCase();
6192 if (contentDescriptionLowerCase.contains(searchedLowerCase)) {
6193 outViews.add(this);
6194 }
6195 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006196 }
6197
6198 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006199 * Find and return all touchable views that are descendants of this view,
6200 * possibly including this view if it is touchable itself.
6201 *
6202 * @return A list of touchable views
6203 */
6204 public ArrayList<View> getTouchables() {
6205 ArrayList<View> result = new ArrayList<View>();
6206 addTouchables(result);
6207 return result;
6208 }
6209
6210 /**
6211 * Add any touchable views that are descendants of this view (possibly
6212 * including this view if it is touchable itself) to views.
6213 *
6214 * @param views Touchable views found so far
6215 */
6216 public void addTouchables(ArrayList<View> views) {
6217 final int viewFlags = mViewFlags;
6218
6219 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)
6220 && (viewFlags & ENABLED_MASK) == ENABLED) {
6221 views.add(this);
6222 }
6223 }
6224
6225 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -07006226 * Returns whether this View is accessibility focused.
6227 *
6228 * @return True if this View is accessibility focused.
6229 */
6230 boolean isAccessibilityFocused() {
Dianne Hackborn4702a852012-08-17 15:18:29 -07006231 return (mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) != 0;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006232 }
6233
6234 /**
6235 * Call this to try to give accessibility focus to this view.
6236 *
6237 * A view will not actually take focus if {@link AccessibilityManager#isEnabled()}
6238 * returns false or the view is no visible or the view already has accessibility
6239 * focus.
6240 *
6241 * See also {@link #focusSearch(int)}, which is what you call to say that you
6242 * have focus, and you want your parent to look for the next one.
6243 *
6244 * @return Whether this view actually took accessibility focus.
6245 *
6246 * @hide
6247 */
6248 public boolean requestAccessibilityFocus() {
Svetoslav Ganov07b726c2012-04-30 12:24:57 -07006249 AccessibilityManager manager = AccessibilityManager.getInstance(mContext);
6250 if (!manager.isEnabled() || !manager.isTouchExplorationEnabled()) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006251 return false;
6252 }
6253 if ((mViewFlags & VISIBILITY_MASK) != VISIBLE) {
6254 return false;
6255 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07006256 if ((mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) == 0) {
6257 mPrivateFlags2 |= PFLAG2_ACCESSIBILITY_FOCUSED;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006258 ViewRootImpl viewRootImpl = getViewRootImpl();
6259 if (viewRootImpl != null) {
Svetoslav Ganov45a02e02012-06-17 15:07:29 -07006260 viewRootImpl.setAccessibilityFocus(this, null);
Svetoslav Ganov42138042012-03-20 11:51:39 -07006261 }
6262 invalidate();
6263 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED);
6264 notifyAccessibilityStateChanged();
Svetoslav Ganov42138042012-03-20 11:51:39 -07006265 return true;
6266 }
6267 return false;
6268 }
6269
6270 /**
6271 * Call this to try to clear accessibility focus of this view.
6272 *
6273 * See also {@link #focusSearch(int)}, which is what you call to say that you
6274 * have focus, and you want your parent to look for the next one.
6275 *
6276 * @hide
6277 */
6278 public void clearAccessibilityFocus() {
Dianne Hackborn4702a852012-08-17 15:18:29 -07006279 if ((mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) != 0) {
6280 mPrivateFlags2 &= ~PFLAG2_ACCESSIBILITY_FOCUSED;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006281 invalidate();
6282 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED);
6283 notifyAccessibilityStateChanged();
Svetoslav Ganov42138042012-03-20 11:51:39 -07006284 }
Svetoslav Ganovc00d0082012-05-22 18:37:49 -07006285 // Clear the global reference of accessibility focus if this
6286 // view or any of its descendants had accessibility focus.
6287 ViewRootImpl viewRootImpl = getViewRootImpl();
6288 if (viewRootImpl != null) {
6289 View focusHost = viewRootImpl.getAccessibilityFocusedHost();
6290 if (focusHost != null && ViewRootImpl.isViewDescendantOf(focusHost, this)) {
Svetoslav Ganov45a02e02012-06-17 15:07:29 -07006291 viewRootImpl.setAccessibilityFocus(null, null);
Svetoslav Ganovc00d0082012-05-22 18:37:49 -07006292 }
6293 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006294 }
6295
Svetoslav Ganov8ffe8b32012-06-15 10:31:31 -07006296 private void sendAccessibilityHoverEvent(int eventType) {
6297 // Since we are not delivering to a client accessibility events from not
6298 // important views (unless the clinet request that) we need to fire the
6299 // event from the deepest view exposed to the client. As a consequence if
6300 // the user crosses a not exposed view the client will see enter and exit
6301 // of the exposed predecessor followed by and enter and exit of that same
6302 // predecessor when entering and exiting the not exposed descendant. This
6303 // is fine since the client has a clear idea which view is hovered at the
6304 // price of a couple more events being sent. This is a simple and
6305 // working solution.
6306 View source = this;
6307 while (true) {
6308 if (source.includeForAccessibility()) {
6309 source.sendAccessibilityEvent(eventType);
6310 return;
6311 }
6312 ViewParent parent = source.getParent();
6313 if (parent instanceof View) {
6314 source = (View) parent;
6315 } else {
6316 return;
6317 }
6318 }
6319 }
6320
Svetoslav Ganov42138042012-03-20 11:51:39 -07006321 /**
6322 * Clears accessibility focus without calling any callback methods
6323 * normally invoked in {@link #clearAccessibilityFocus()}. This method
6324 * is used for clearing accessibility focus when giving this focus to
6325 * another view.
6326 */
6327 void clearAccessibilityFocusNoCallbacks() {
Dianne Hackborn4702a852012-08-17 15:18:29 -07006328 if ((mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) != 0) {
6329 mPrivateFlags2 &= ~PFLAG2_ACCESSIBILITY_FOCUSED;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006330 invalidate();
6331 }
6332 }
6333
6334 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006335 * Call this to try to give focus to a specific view or to one of its
6336 * descendants.
6337 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006338 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
6339 * false), or if it is focusable and it is not focusable in touch mode
6340 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006341 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07006342 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006343 * have focus, and you want your parent to look for the next one.
6344 *
6345 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments
6346 * {@link #FOCUS_DOWN} and <code>null</code>.
6347 *
6348 * @return Whether this view or one of its descendants actually took focus.
6349 */
6350 public final boolean requestFocus() {
6351 return requestFocus(View.FOCUS_DOWN);
6352 }
6353
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006354 /**
6355 * Call this to try to give focus to a specific view or to one of its
6356 * descendants and give it a hint about what direction focus is heading.
6357 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006358 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
6359 * false), or if it is focusable and it is not focusable in touch mode
6360 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006361 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07006362 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006363 * have focus, and you want your parent to look for the next one.
6364 *
6365 * This is equivalent to calling {@link #requestFocus(int, Rect)} with
6366 * <code>null</code> set for the previously focused rectangle.
6367 *
6368 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
6369 * @return Whether this view or one of its descendants actually took focus.
6370 */
6371 public final boolean requestFocus(int direction) {
6372 return requestFocus(direction, null);
6373 }
6374
6375 /**
6376 * Call this to try to give focus to a specific view or to one of its descendants
6377 * and give it hints about the direction and a specific rectangle that the focus
6378 * is coming from. The rectangle can help give larger views a finer grained hint
6379 * about where focus is coming from, and therefore, where to show selection, or
6380 * forward focus change internally.
6381 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006382 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
6383 * false), or if it is focusable and it is not focusable in touch mode
6384 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006385 *
6386 * A View will not take focus if it is not visible.
6387 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006388 * A View will not take focus if one of its parents has
6389 * {@link android.view.ViewGroup#getDescendantFocusability()} equal to
6390 * {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006391 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07006392 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006393 * have focus, and you want your parent to look for the next one.
6394 *
6395 * You may wish to override this method if your custom {@link View} has an internal
6396 * {@link View} that it wishes to forward the request to.
6397 *
6398 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
6399 * @param previouslyFocusedRect The rectangle (in this View's coordinate system)
6400 * to give a finer grained hint about where focus is coming from. May be null
6401 * if there is no hint.
6402 * @return Whether this view or one of its descendants actually took focus.
6403 */
6404 public boolean requestFocus(int direction, Rect previouslyFocusedRect) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006405 return requestFocusNoSearch(direction, previouslyFocusedRect);
6406 }
6407
6408 private boolean requestFocusNoSearch(int direction, Rect previouslyFocusedRect) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006409 // need to be focusable
6410 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE ||
6411 (mViewFlags & VISIBILITY_MASK) != VISIBLE) {
6412 return false;
6413 }
6414
6415 // need to be focusable in touch mode if in touch mode
6416 if (isInTouchMode() &&
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006417 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) {
6418 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006419 }
6420
6421 // need to not have any parents blocking us
6422 if (hasAncestorThatBlocksDescendantFocus()) {
6423 return false;
6424 }
6425
6426 handleFocusGainInternal(direction, previouslyFocusedRect);
6427 return true;
6428 }
6429
6430 /**
6431 * Call this to try to give focus to a specific view or to one of its descendants. This is a
6432 * special variant of {@link #requestFocus() } that will allow views that are not focuable in
6433 * touch mode to request focus when they are touched.
6434 *
6435 * @return Whether this view or one of its descendants actually took focus.
6436 *
6437 * @see #isInTouchMode()
6438 *
6439 */
6440 public final boolean requestFocusFromTouch() {
6441 // Leave touch mode if we need to
6442 if (isInTouchMode()) {
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07006443 ViewRootImpl viewRoot = getViewRootImpl();
Christopher Tate2c095f32010-10-04 14:13:40 -07006444 if (viewRoot != null) {
6445 viewRoot.ensureTouchMode(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006446 }
6447 }
6448 return requestFocus(View.FOCUS_DOWN);
6449 }
6450
6451 /**
6452 * @return Whether any ancestor of this view blocks descendant focus.
6453 */
6454 private boolean hasAncestorThatBlocksDescendantFocus() {
6455 ViewParent ancestor = mParent;
6456 while (ancestor instanceof ViewGroup) {
6457 final ViewGroup vgAncestor = (ViewGroup) ancestor;
6458 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) {
6459 return true;
6460 } else {
6461 ancestor = vgAncestor.getParent();
6462 }
6463 }
6464 return false;
6465 }
6466
6467 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -07006468 * Gets the mode for determining whether this View is important for accessibility
6469 * which is if it fires accessibility events and if it is reported to
6470 * accessibility services that query the screen.
6471 *
6472 * @return The mode for determining whether a View is important for accessibility.
6473 *
6474 * @attr ref android.R.styleable#View_importantForAccessibility
6475 *
6476 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES
6477 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO
6478 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO
6479 */
6480 @ViewDebug.ExportedProperty(category = "accessibility", mapping = {
Svetoslav Ganovf9817f72012-05-22 18:10:31 -07006481 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_AUTO, to = "auto"),
6482 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_YES, to = "yes"),
6483 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_NO, to = "no")
Svetoslav Ganov42138042012-03-20 11:51:39 -07006484 })
6485 public int getImportantForAccessibility() {
Dianne Hackborn4702a852012-08-17 15:18:29 -07006486 return (mPrivateFlags2 & PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK)
6487 >> PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006488 }
6489
6490 /**
6491 * Sets how to determine whether this view is important for accessibility
6492 * which is if it fires accessibility events and if it is reported to
6493 * accessibility services that query the screen.
6494 *
6495 * @param mode How to determine whether this view is important for accessibility.
6496 *
6497 * @attr ref android.R.styleable#View_importantForAccessibility
6498 *
6499 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES
6500 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO
6501 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO
6502 */
6503 public void setImportantForAccessibility(int mode) {
6504 if (mode != getImportantForAccessibility()) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07006505 mPrivateFlags2 &= ~PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK;
6506 mPrivateFlags2 |= (mode << PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT)
6507 & PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006508 notifyAccessibilityStateChanged();
6509 }
6510 }
6511
6512 /**
6513 * Gets whether this view should be exposed for accessibility.
6514 *
6515 * @return Whether the view is exposed for accessibility.
6516 *
6517 * @hide
6518 */
6519 public boolean isImportantForAccessibility() {
Dianne Hackborn4702a852012-08-17 15:18:29 -07006520 final int mode = (mPrivateFlags2 & PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK)
6521 >> PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006522 switch (mode) {
6523 case IMPORTANT_FOR_ACCESSIBILITY_YES:
6524 return true;
6525 case IMPORTANT_FOR_ACCESSIBILITY_NO:
6526 return false;
6527 case IMPORTANT_FOR_ACCESSIBILITY_AUTO:
Svetoslav Ganov34caec92012-07-19 18:07:58 -07006528 return isActionableForAccessibility() || hasListenersForAccessibility()
6529 || getAccessibilityNodeProvider() != null;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006530 default:
6531 throw new IllegalArgumentException("Unknow important for accessibility mode: "
6532 + mode);
6533 }
6534 }
6535
6536 /**
6537 * Gets the parent for accessibility purposes. Note that the parent for
6538 * accessibility is not necessary the immediate parent. It is the first
6539 * predecessor that is important for accessibility.
6540 *
6541 * @return The parent for accessibility purposes.
6542 */
6543 public ViewParent getParentForAccessibility() {
6544 if (mParent instanceof View) {
6545 View parentView = (View) mParent;
6546 if (parentView.includeForAccessibility()) {
6547 return mParent;
6548 } else {
6549 return mParent.getParentForAccessibility();
6550 }
6551 }
6552 return null;
6553 }
6554
6555 /**
6556 * Adds the children of a given View for accessibility. Since some Views are
6557 * not important for accessibility the children for accessibility are not
6558 * necessarily direct children of the riew, rather they are the first level of
6559 * descendants important for accessibility.
6560 *
6561 * @param children The list of children for accessibility.
6562 */
6563 public void addChildrenForAccessibility(ArrayList<View> children) {
6564 if (includeForAccessibility()) {
6565 children.add(this);
6566 }
6567 }
6568
6569 /**
6570 * Whether to regard this view for accessibility. A view is regarded for
6571 * accessibility if it is important for accessibility or the querying
6572 * accessibility service has explicitly requested that view not
6573 * important for accessibility are regarded.
6574 *
6575 * @return Whether to regard the view for accessibility.
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07006576 *
6577 * @hide
Svetoslav Ganov42138042012-03-20 11:51:39 -07006578 */
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07006579 public boolean includeForAccessibility() {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006580 if (mAttachInfo != null) {
Romain Guyf0af1d52012-07-11 18:31:21 -07006581 return mAttachInfo.mIncludeNotImportantViews || isImportantForAccessibility();
Svetoslav Ganov42138042012-03-20 11:51:39 -07006582 }
6583 return false;
6584 }
6585
6586 /**
6587 * Returns whether the View is considered actionable from
6588 * accessibility perspective. Such view are important for
6589 * accessiiblity.
6590 *
6591 * @return True if the view is actionable for accessibility.
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07006592 *
6593 * @hide
Svetoslav Ganov42138042012-03-20 11:51:39 -07006594 */
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07006595 public boolean isActionableForAccessibility() {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006596 return (isClickable() || isLongClickable() || isFocusable());
6597 }
6598
6599 /**
6600 * Returns whether the View has registered callbacks wich makes it
6601 * important for accessiiblity.
6602 *
6603 * @return True if the view is actionable for accessibility.
6604 */
6605 private boolean hasListenersForAccessibility() {
6606 ListenerInfo info = getListenerInfo();
6607 return mTouchDelegate != null || info.mOnKeyListener != null
6608 || info.mOnTouchListener != null || info.mOnGenericMotionListener != null
6609 || info.mOnHoverListener != null || info.mOnDragListener != null;
6610 }
6611
6612 /**
6613 * Notifies accessibility services that some view's important for
6614 * accessibility state has changed. Note that such notifications
6615 * are made at most once every
6616 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}
6617 * to avoid unnecessary load to the system. Also once a view has
6618 * made a notifucation this method is a NOP until the notification has
6619 * been sent to clients.
6620 *
6621 * @hide
6622 *
6623 * TODO: Makse sure this method is called for any view state change
6624 * that is interesting for accessilility purposes.
6625 */
6626 public void notifyAccessibilityStateChanged() {
Svetoslav Ganovc406be92012-05-11 16:12:32 -07006627 if (!AccessibilityManager.getInstance(mContext).isEnabled()) {
6628 return;
6629 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07006630 if ((mPrivateFlags2 & PFLAG2_ACCESSIBILITY_STATE_CHANGED) == 0) {
6631 mPrivateFlags2 |= PFLAG2_ACCESSIBILITY_STATE_CHANGED;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006632 if (mParent != null) {
6633 mParent.childAccessibilityStateChanged(this);
6634 }
6635 }
6636 }
6637
6638 /**
6639 * Reset the state indicating the this view has requested clients
6640 * interested in its accessiblity state to be notified.
6641 *
6642 * @hide
6643 */
6644 public void resetAccessibilityStateChanged() {
Dianne Hackborn4702a852012-08-17 15:18:29 -07006645 mPrivateFlags2 &= ~PFLAG2_ACCESSIBILITY_STATE_CHANGED;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006646 }
6647
6648 /**
6649 * Performs the specified accessibility action on the view. For
6650 * possible accessibility actions look at {@link AccessibilityNodeInfo}.
alanv8eeefef2012-05-07 16:57:53 -07006651 * <p>
6652 * If an {@link AccessibilityDelegate} has been specified via calling
6653 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
6654 * {@link AccessibilityDelegate#performAccessibilityAction(View, int, Bundle)}
6655 * is responsible for handling this call.
6656 * </p>
Svetoslav Ganov42138042012-03-20 11:51:39 -07006657 *
6658 * @param action The action to perform.
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006659 * @param arguments Optional action arguments.
Svetoslav Ganov42138042012-03-20 11:51:39 -07006660 * @return Whether the action was performed.
6661 */
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006662 public boolean performAccessibilityAction(int action, Bundle arguments) {
alanv8eeefef2012-05-07 16:57:53 -07006663 if (mAccessibilityDelegate != null) {
6664 return mAccessibilityDelegate.performAccessibilityAction(this, action, arguments);
6665 } else {
6666 return performAccessibilityActionInternal(action, arguments);
6667 }
6668 }
6669
6670 /**
6671 * @see #performAccessibilityAction(int, Bundle)
6672 *
6673 * Note: Called from the default {@link AccessibilityDelegate}.
6674 */
6675 boolean performAccessibilityActionInternal(int action, Bundle arguments) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006676 switch (action) {
6677 case AccessibilityNodeInfo.ACTION_CLICK: {
Svetoslav Ganov005b83b2012-04-16 18:17:17 -07006678 if (isClickable()) {
Svetoslav Ganov773f2622012-05-05 19:59:42 -07006679 return performClick();
Svetoslav Ganov005b83b2012-04-16 18:17:17 -07006680 }
6681 } break;
6682 case AccessibilityNodeInfo.ACTION_LONG_CLICK: {
6683 if (isLongClickable()) {
Svetoslav Ganov773f2622012-05-05 19:59:42 -07006684 return performLongClick();
Svetoslav Ganov005b83b2012-04-16 18:17:17 -07006685 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006686 } break;
6687 case AccessibilityNodeInfo.ACTION_FOCUS: {
6688 if (!hasFocus()) {
6689 // Get out of touch mode since accessibility
6690 // wants to move focus around.
6691 getViewRootImpl().ensureTouchMode(false);
6692 return requestFocus();
6693 }
6694 } break;
6695 case AccessibilityNodeInfo.ACTION_CLEAR_FOCUS: {
6696 if (hasFocus()) {
6697 clearFocus();
6698 return !isFocused();
6699 }
6700 } break;
6701 case AccessibilityNodeInfo.ACTION_SELECT: {
6702 if (!isSelected()) {
6703 setSelected(true);
6704 return isSelected();
6705 }
6706 } break;
6707 case AccessibilityNodeInfo.ACTION_CLEAR_SELECTION: {
6708 if (isSelected()) {
6709 setSelected(false);
6710 return !isSelected();
6711 }
6712 } break;
6713 case AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS: {
Svetoslav Ganov27e2da72012-07-02 18:12:00 -07006714 if (!isAccessibilityFocused()) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006715 return requestAccessibilityFocus();
6716 }
6717 } break;
6718 case AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS: {
6719 if (isAccessibilityFocused()) {
6720 clearAccessibilityFocus();
6721 return true;
6722 }
6723 } break;
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006724 case AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY: {
6725 if (arguments != null) {
6726 final int granularity = arguments.getInt(
6727 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT);
6728 return nextAtGranularity(granularity);
6729 }
6730 } break;
6731 case AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY: {
6732 if (arguments != null) {
6733 final int granularity = arguments.getInt(
6734 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT);
6735 return previousAtGranularity(granularity);
6736 }
6737 } break;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006738 }
6739 return false;
6740 }
6741
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006742 private boolean nextAtGranularity(int granularity) {
6743 CharSequence text = getIterableTextForAccessibility();
Svetoslav Ganov64899e52012-05-15 21:09:30 -07006744 if (text == null || text.length() == 0) {
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006745 return false;
6746 }
6747 TextSegmentIterator iterator = getIteratorForGranularity(granularity);
6748 if (iterator == null) {
6749 return false;
6750 }
6751 final int current = getAccessibilityCursorPosition();
6752 final int[] range = iterator.following(current);
6753 if (range == null) {
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006754 return false;
6755 }
6756 final int start = range[0];
6757 final int end = range[1];
Svetoslav Ganov39f2aee2012-05-29 09:15:30 -07006758 setAccessibilityCursorPosition(end);
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006759 sendViewTextTraversedAtGranularityEvent(
6760 AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY,
6761 granularity, start, end);
6762 return true;
6763 }
6764
6765 private boolean previousAtGranularity(int granularity) {
6766 CharSequence text = getIterableTextForAccessibility();
Svetoslav Ganov64899e52012-05-15 21:09:30 -07006767 if (text == null || text.length() == 0) {
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006768 return false;
6769 }
6770 TextSegmentIterator iterator = getIteratorForGranularity(granularity);
6771 if (iterator == null) {
6772 return false;
6773 }
Svetoslav Ganov39f2aee2012-05-29 09:15:30 -07006774 int current = getAccessibilityCursorPosition();
6775 if (current == ACCESSIBILITY_CURSOR_POSITION_UNDEFINED) {
6776 current = text.length();
6777 } else if (granularity == AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER) {
6778 // When traversing by character we always put the cursor after the character
6779 // to ease edit and have to compensate before asking the for previous segment.
6780 current--;
6781 }
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006782 final int[] range = iterator.preceding(current);
6783 if (range == null) {
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006784 return false;
6785 }
6786 final int start = range[0];
6787 final int end = range[1];
Svetoslav Ganov39f2aee2012-05-29 09:15:30 -07006788 // Always put the cursor after the character to ease edit.
6789 if (granularity == AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER) {
6790 setAccessibilityCursorPosition(end);
6791 } else {
6792 setAccessibilityCursorPosition(start);
6793 }
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006794 sendViewTextTraversedAtGranularityEvent(
6795 AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY,
6796 granularity, start, end);
6797 return true;
6798 }
6799
6800 /**
6801 * Gets the text reported for accessibility purposes.
6802 *
6803 * @return The accessibility text.
6804 *
6805 * @hide
6806 */
6807 public CharSequence getIterableTextForAccessibility() {
6808 return mContentDescription;
6809 }
6810
6811 /**
6812 * @hide
6813 */
6814 public int getAccessibilityCursorPosition() {
6815 return mAccessibilityCursorPosition;
6816 }
6817
6818 /**
6819 * @hide
6820 */
6821 public void setAccessibilityCursorPosition(int position) {
6822 mAccessibilityCursorPosition = position;
6823 }
6824
6825 private void sendViewTextTraversedAtGranularityEvent(int action, int granularity,
6826 int fromIndex, int toIndex) {
6827 if (mParent == null) {
6828 return;
6829 }
6830 AccessibilityEvent event = AccessibilityEvent.obtain(
6831 AccessibilityEvent.TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY);
6832 onInitializeAccessibilityEvent(event);
6833 onPopulateAccessibilityEvent(event);
6834 event.setFromIndex(fromIndex);
6835 event.setToIndex(toIndex);
6836 event.setAction(action);
6837 event.setMovementGranularity(granularity);
6838 mParent.requestSendAccessibilityEvent(this, event);
6839 }
6840
6841 /**
6842 * @hide
6843 */
6844 public TextSegmentIterator getIteratorForGranularity(int granularity) {
6845 switch (granularity) {
6846 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER: {
6847 CharSequence text = getIterableTextForAccessibility();
6848 if (text != null && text.length() > 0) {
6849 CharacterTextSegmentIterator iterator =
Svetoslav Ganovbbd31552012-06-11 12:08:18 -07006850 CharacterTextSegmentIterator.getInstance(
6851 mContext.getResources().getConfiguration().locale);
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006852 iterator.initialize(text.toString());
6853 return iterator;
6854 }
6855 } break;
6856 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD: {
6857 CharSequence text = getIterableTextForAccessibility();
6858 if (text != null && text.length() > 0) {
6859 WordTextSegmentIterator iterator =
Svetoslav Ganovbbd31552012-06-11 12:08:18 -07006860 WordTextSegmentIterator.getInstance(
6861 mContext.getResources().getConfiguration().locale);
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006862 iterator.initialize(text.toString());
6863 return iterator;
6864 }
6865 } break;
6866 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH: {
6867 CharSequence text = getIterableTextForAccessibility();
6868 if (text != null && text.length() > 0) {
6869 ParagraphTextSegmentIterator iterator =
6870 ParagraphTextSegmentIterator.getInstance();
6871 iterator.initialize(text.toString());
6872 return iterator;
6873 }
6874 } break;
6875 }
6876 return null;
6877 }
6878
Svetoslav Ganov42138042012-03-20 11:51:39 -07006879 /**
Romain Guya440b002010-02-24 15:57:54 -08006880 * @hide
6881 */
6882 public void dispatchStartTemporaryDetach() {
Svetoslav Ganov961bf0e2012-05-08 09:40:03 -07006883 clearAccessibilityFocus();
Romain Guy38c2ece2012-05-24 14:20:56 -07006884 clearDisplayList();
6885
Romain Guya440b002010-02-24 15:57:54 -08006886 onStartTemporaryDetach();
6887 }
6888
6889 /**
6890 * This is called when a container is going to temporarily detach a child, with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006891 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}.
6892 * It will either be followed by {@link #onFinishTemporaryDetach()} or
Romain Guya440b002010-02-24 15:57:54 -08006893 * {@link #onDetachedFromWindow()} when the container is done.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006894 */
6895 public void onStartTemporaryDetach() {
Romain Guya440b002010-02-24 15:57:54 -08006896 removeUnsetPressCallback();
Dianne Hackborn4702a852012-08-17 15:18:29 -07006897 mPrivateFlags |= PFLAG_CANCEL_NEXT_UP_EVENT;
Romain Guya440b002010-02-24 15:57:54 -08006898 }
6899
6900 /**
6901 * @hide
6902 */
6903 public void dispatchFinishTemporaryDetach() {
6904 onFinishTemporaryDetach();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006905 }
Romain Guy8506ab42009-06-11 17:35:47 -07006906
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006907 /**
6908 * Called after {@link #onStartTemporaryDetach} when the container is done
6909 * changing the view.
6910 */
6911 public void onFinishTemporaryDetach() {
6912 }
Romain Guy8506ab42009-06-11 17:35:47 -07006913
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006914 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07006915 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState}
6916 * for this view's window. Returns null if the view is not currently attached
6917 * to the window. Normally you will not need to use this directly, but
Romain Guy5c22a8c2011-05-13 11:48:45 -07006918 * just use the standard high-level event callbacks like
6919 * {@link #onKeyDown(int, KeyEvent)}.
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07006920 */
6921 public KeyEvent.DispatcherState getKeyDispatcherState() {
6922 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null;
6923 }
Joe Malin32736f02011-01-19 16:14:20 -08006924
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07006925 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006926 * Dispatch a key event before it is processed by any input method
6927 * associated with the view hierarchy. This can be used to intercept
6928 * key events in special situations before the IME consumes them; a
6929 * typical example would be handling the BACK key to update the application's
6930 * UI instead of allowing the IME to see it and close itself.
6931 *
6932 * @param event The key event to be dispatched.
6933 * @return True if the event was handled, false otherwise.
6934 */
6935 public boolean dispatchKeyEventPreIme(KeyEvent event) {
6936 return onKeyPreIme(event.getKeyCode(), event);
6937 }
6938
6939 /**
6940 * Dispatch a key event to the next view on the focus path. This path runs
6941 * from the top of the view tree down to the currently focused view. If this
6942 * view has focus, it will dispatch to itself. Otherwise it will dispatch
6943 * the next node down the focus path. This method also fires any key
6944 * listeners.
6945 *
6946 * @param event The key event to be dispatched.
6947 * @return True if the event was handled, false otherwise.
6948 */
6949 public boolean dispatchKeyEvent(KeyEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08006950 if (mInputEventConsistencyVerifier != null) {
6951 mInputEventConsistencyVerifier.onKeyEvent(event, 0);
6952 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006953
Jeff Brown21bc5c92011-02-28 18:27:14 -08006954 // Give any attached key listener a first crack at the event.
Romain Guyf607bdc2010-09-10 19:20:06 -07006955 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07006956 ListenerInfo li = mListenerInfo;
6957 if (li != null && li.mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
6958 && li.mOnKeyListener.onKey(this, event.getKeyCode(), event)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006959 return true;
6960 }
6961
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006962 if (event.dispatch(this, mAttachInfo != null
6963 ? mAttachInfo.mKeyDispatchState : null, this)) {
6964 return true;
6965 }
6966
6967 if (mInputEventConsistencyVerifier != null) {
6968 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
6969 }
6970 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006971 }
6972
6973 /**
6974 * Dispatches a key shortcut event.
6975 *
6976 * @param event The key event to be dispatched.
6977 * @return True if the event was handled by the view, false otherwise.
6978 */
6979 public boolean dispatchKeyShortcutEvent(KeyEvent event) {
6980 return onKeyShortcut(event.getKeyCode(), event);
6981 }
6982
6983 /**
6984 * Pass the touch screen motion event down to the target view, or this
6985 * view if it is the target.
6986 *
6987 * @param event The motion event to be dispatched.
6988 * @return True if the event was handled by the view, false otherwise.
6989 */
6990 public boolean dispatchTouchEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08006991 if (mInputEventConsistencyVerifier != null) {
6992 mInputEventConsistencyVerifier.onTouchEvent(event, 0);
6993 }
6994
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006995 if (onFilterTouchEventForSecurity(event)) {
6996 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07006997 ListenerInfo li = mListenerInfo;
6998 if (li != null && li.mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
6999 && li.mOnTouchListener.onTouch(this, event)) {
Jeff Brownbbdc50b2011-04-19 23:46:52 -07007000 return true;
7001 }
7002
7003 if (onTouchEvent(event)) {
7004 return true;
7005 }
Jeff Brown85a31762010-09-01 17:01:00 -07007006 }
7007
Jeff Brownbbdc50b2011-04-19 23:46:52 -07007008 if (mInputEventConsistencyVerifier != null) {
7009 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007010 }
Jeff Brownbbdc50b2011-04-19 23:46:52 -07007011 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007012 }
7013
7014 /**
Jeff Brown85a31762010-09-01 17:01:00 -07007015 * Filter the touch event to apply security policies.
7016 *
7017 * @param event The motion event to be filtered.
7018 * @return True if the event should be dispatched, false if the event should be dropped.
Joe Malin32736f02011-01-19 16:14:20 -08007019 *
Jeff Brown85a31762010-09-01 17:01:00 -07007020 * @see #getFilterTouchesWhenObscured
7021 */
7022 public boolean onFilterTouchEventForSecurity(MotionEvent event) {
Romain Guyf607bdc2010-09-10 19:20:06 -07007023 //noinspection RedundantIfStatement
Jeff Brown85a31762010-09-01 17:01:00 -07007024 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0
7025 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) {
7026 // Window is obscured, drop this touch.
7027 return false;
7028 }
7029 return true;
7030 }
7031
7032 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007033 * Pass a trackball motion event down to the focused view.
7034 *
7035 * @param event The motion event to be dispatched.
7036 * @return True if the event was handled by the view, false otherwise.
7037 */
7038 public boolean dispatchTrackballEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08007039 if (mInputEventConsistencyVerifier != null) {
7040 mInputEventConsistencyVerifier.onTrackballEvent(event, 0);
7041 }
7042
Romain Guy02ccac62011-06-24 13:20:23 -07007043 return onTrackballEvent(event);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007044 }
7045
7046 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08007047 * Dispatch a generic motion event.
7048 * <p>
7049 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER}
7050 * are delivered to the view under the pointer. All other generic motion events are
Jeff Browna032cc02011-03-07 16:56:21 -08007051 * delivered to the focused view. Hover events are handled specially and are delivered
Romain Guy5c22a8c2011-05-13 11:48:45 -07007052 * to {@link #onHoverEvent(MotionEvent)}.
Jeff Brown33bbfd22011-02-24 20:55:35 -08007053 * </p>
Jeff Browncb1404e2011-01-15 18:14:15 -08007054 *
7055 * @param event The motion event to be dispatched.
7056 * @return True if the event was handled by the view, false otherwise.
7057 */
7058 public boolean dispatchGenericMotionEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08007059 if (mInputEventConsistencyVerifier != null) {
7060 mInputEventConsistencyVerifier.onGenericMotionEvent(event, 0);
7061 }
7062
Jeff Browna032cc02011-03-07 16:56:21 -08007063 final int source = event.getSource();
7064 if ((source & InputDevice.SOURCE_CLASS_POINTER) != 0) {
7065 final int action = event.getAction();
7066 if (action == MotionEvent.ACTION_HOVER_ENTER
7067 || action == MotionEvent.ACTION_HOVER_MOVE
7068 || action == MotionEvent.ACTION_HOVER_EXIT) {
7069 if (dispatchHoverEvent(event)) {
7070 return true;
7071 }
7072 } else if (dispatchGenericPointerEvent(event)) {
7073 return true;
7074 }
7075 } else if (dispatchGenericFocusedEvent(event)) {
7076 return true;
7077 }
7078
Jeff Brown10b62902011-06-20 16:40:37 -07007079 if (dispatchGenericMotionEventInternal(event)) {
7080 return true;
7081 }
7082
7083 if (mInputEventConsistencyVerifier != null) {
7084 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
7085 }
7086 return false;
7087 }
7088
7089 private boolean dispatchGenericMotionEventInternal(MotionEvent event) {
Romain Guy7b5b6ab2011-03-14 18:05:08 -07007090 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07007091 ListenerInfo li = mListenerInfo;
7092 if (li != null && li.mOnGenericMotionListener != null
7093 && (mViewFlags & ENABLED_MASK) == ENABLED
7094 && li.mOnGenericMotionListener.onGenericMotion(this, event)) {
Jeff Brown33bbfd22011-02-24 20:55:35 -08007095 return true;
7096 }
Jeff Brownbbdc50b2011-04-19 23:46:52 -07007097
7098 if (onGenericMotionEvent(event)) {
7099 return true;
7100 }
7101
7102 if (mInputEventConsistencyVerifier != null) {
7103 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
7104 }
7105 return false;
Jeff Browncb1404e2011-01-15 18:14:15 -08007106 }
7107
7108 /**
Jeff Browna032cc02011-03-07 16:56:21 -08007109 * Dispatch a hover event.
7110 * <p>
Philip Milne6c8ea062012-04-03 17:38:43 -07007111 * Do not call this method directly.
Romain Guy5c22a8c2011-05-13 11:48:45 -07007112 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08007113 * </p>
7114 *
7115 * @param event The motion event to be dispatched.
7116 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08007117 */
7118 protected boolean dispatchHoverEvent(MotionEvent event) {
Romain Guy02ccac62011-06-24 13:20:23 -07007119 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07007120 ListenerInfo li = mListenerInfo;
7121 if (li != null && li.mOnHoverListener != null
7122 && (mViewFlags & ENABLED_MASK) == ENABLED
7123 && li.mOnHoverListener.onHover(this, event)) {
Jeff Brown10b62902011-06-20 16:40:37 -07007124 return true;
7125 }
7126
Jeff Browna032cc02011-03-07 16:56:21 -08007127 return onHoverEvent(event);
7128 }
7129
7130 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07007131 * Returns true if the view has a child to which it has recently sent
7132 * {@link MotionEvent#ACTION_HOVER_ENTER}. If this view is hovered and
7133 * it does not have a hovered child, then it must be the innermost hovered view.
7134 * @hide
7135 */
7136 protected boolean hasHoveredChild() {
7137 return false;
7138 }
7139
7140 /**
Jeff Browna032cc02011-03-07 16:56:21 -08007141 * Dispatch a generic motion event to the view under the first pointer.
7142 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07007143 * Do not call this method directly.
7144 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08007145 * </p>
7146 *
7147 * @param event The motion event to be dispatched.
7148 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08007149 */
7150 protected boolean dispatchGenericPointerEvent(MotionEvent event) {
7151 return false;
7152 }
7153
7154 /**
7155 * Dispatch a generic motion event to the currently focused view.
7156 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07007157 * Do not call this method directly.
7158 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08007159 * </p>
7160 *
7161 * @param event The motion event to be dispatched.
7162 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08007163 */
7164 protected boolean dispatchGenericFocusedEvent(MotionEvent event) {
7165 return false;
7166 }
7167
7168 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08007169 * Dispatch a pointer event.
7170 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07007171 * Dispatches touch related pointer events to {@link #onTouchEvent(MotionEvent)} and all
7172 * other events to {@link #onGenericMotionEvent(MotionEvent)}. This separation of concerns
7173 * reinforces the invariant that {@link #onTouchEvent(MotionEvent)} is really about touches
Jeff Brown33bbfd22011-02-24 20:55:35 -08007174 * and should not be expected to handle other pointing device features.
7175 * </p>
7176 *
7177 * @param event The motion event to be dispatched.
7178 * @return True if the event was handled by the view, false otherwise.
7179 * @hide
7180 */
7181 public final boolean dispatchPointerEvent(MotionEvent event) {
7182 if (event.isTouchEvent()) {
7183 return dispatchTouchEvent(event);
7184 } else {
7185 return dispatchGenericMotionEvent(event);
7186 }
7187 }
7188
7189 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007190 * Called when the window containing this view gains or loses window focus.
7191 * ViewGroups should override to route to their children.
7192 *
7193 * @param hasFocus True if the window containing this view now has focus,
7194 * false otherwise.
7195 */
7196 public void dispatchWindowFocusChanged(boolean hasFocus) {
7197 onWindowFocusChanged(hasFocus);
7198 }
7199
7200 /**
7201 * Called when the window containing this view gains or loses focus. Note
7202 * that this is separate from view focus: to receive key events, both
7203 * your view and its window must have focus. If a window is displayed
7204 * on top of yours that takes input focus, then your own window will lose
7205 * focus but the view focus will remain unchanged.
7206 *
7207 * @param hasWindowFocus True if the window containing this view now has
7208 * focus, false otherwise.
7209 */
7210 public void onWindowFocusChanged(boolean hasWindowFocus) {
7211 InputMethodManager imm = InputMethodManager.peekInstance();
7212 if (!hasWindowFocus) {
7213 if (isPressed()) {
7214 setPressed(false);
7215 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07007216 if (imm != null && (mPrivateFlags & PFLAG_FOCUSED) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007217 imm.focusOut(this);
7218 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05007219 removeLongPressCallback();
Tony Wu26edf202010-09-13 19:54:00 +08007220 removeTapCallback();
Romain Guya2431d02009-04-30 16:30:00 -07007221 onFocusLost();
Dianne Hackborn4702a852012-08-17 15:18:29 -07007222 } else if (imm != null && (mPrivateFlags & PFLAG_FOCUSED) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007223 imm.focusIn(this);
7224 }
7225 refreshDrawableState();
7226 }
7227
7228 /**
7229 * Returns true if this view is in a window that currently has window focus.
7230 * Note that this is not the same as the view itself having focus.
7231 *
7232 * @return True if this view is in a window that currently has window focus.
7233 */
7234 public boolean hasWindowFocus() {
7235 return mAttachInfo != null && mAttachInfo.mHasWindowFocus;
7236 }
7237
7238 /**
Adam Powell326d8082009-12-09 15:10:07 -08007239 * Dispatch a view visibility change down the view hierarchy.
7240 * ViewGroups should override to route to their children.
7241 * @param changedView The view whose visibility changed. Could be 'this' or
7242 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08007243 * @param visibility The new visibility of changedView: {@link #VISIBLE},
7244 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08007245 */
7246 protected void dispatchVisibilityChanged(View changedView, int visibility) {
7247 onVisibilityChanged(changedView, visibility);
7248 }
7249
7250 /**
7251 * Called when the visibility of the view or an ancestor of the view is changed.
7252 * @param changedView The view whose visibility changed. Could be 'this' or
7253 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08007254 * @param visibility The new visibility of changedView: {@link #VISIBLE},
7255 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08007256 */
7257 protected void onVisibilityChanged(View changedView, int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07007258 if (visibility == VISIBLE) {
7259 if (mAttachInfo != null) {
7260 initialAwakenScrollBars();
7261 } else {
Dianne Hackborn4702a852012-08-17 15:18:29 -07007262 mPrivateFlags |= PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH;
Adam Powell8568c3a2010-04-19 14:26:11 -07007263 }
7264 }
Adam Powell326d8082009-12-09 15:10:07 -08007265 }
7266
7267 /**
Romain Guy43c9cdf2010-01-27 13:53:55 -08007268 * Dispatch a hint about whether this view is displayed. For instance, when
7269 * a View moves out of the screen, it might receives a display hint indicating
7270 * the view is not displayed. Applications should not <em>rely</em> on this hint
7271 * as there is no guarantee that they will receive one.
Joe Malin32736f02011-01-19 16:14:20 -08007272 *
Romain Guy43c9cdf2010-01-27 13:53:55 -08007273 * @param hint A hint about whether or not this view is displayed:
7274 * {@link #VISIBLE} or {@link #INVISIBLE}.
7275 */
7276 public void dispatchDisplayHint(int hint) {
7277 onDisplayHint(hint);
7278 }
7279
7280 /**
7281 * Gives this view a hint about whether is displayed or not. For instance, when
7282 * a View moves out of the screen, it might receives a display hint indicating
7283 * the view is not displayed. Applications should not <em>rely</em> on this hint
7284 * as there is no guarantee that they will receive one.
Joe Malin32736f02011-01-19 16:14:20 -08007285 *
Romain Guy43c9cdf2010-01-27 13:53:55 -08007286 * @param hint A hint about whether or not this view is displayed:
7287 * {@link #VISIBLE} or {@link #INVISIBLE}.
7288 */
7289 protected void onDisplayHint(int hint) {
7290 }
7291
7292 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007293 * Dispatch a window visibility change down the view hierarchy.
7294 * ViewGroups should override to route to their children.
7295 *
7296 * @param visibility The new visibility of the window.
7297 *
Philip Milne6c8ea062012-04-03 17:38:43 -07007298 * @see #onWindowVisibilityChanged(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007299 */
7300 public void dispatchWindowVisibilityChanged(int visibility) {
7301 onWindowVisibilityChanged(visibility);
7302 }
7303
7304 /**
7305 * Called when the window containing has change its visibility
7306 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note
7307 * that this tells you whether or not your window is being made visible
7308 * to the window manager; this does <em>not</em> tell you whether or not
7309 * your window is obscured by other windows on the screen, even if it
7310 * is itself visible.
7311 *
7312 * @param visibility The new visibility of the window.
7313 */
7314 protected void onWindowVisibilityChanged(int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07007315 if (visibility == VISIBLE) {
7316 initialAwakenScrollBars();
7317 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007318 }
7319
7320 /**
7321 * Returns the current visibility of the window this view is attached to
7322 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}).
7323 *
7324 * @return Returns the current visibility of the view's window.
7325 */
7326 public int getWindowVisibility() {
7327 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE;
7328 }
7329
7330 /**
7331 * Retrieve the overall visible display size in which the window this view is
7332 * attached to has been positioned in. This takes into account screen
7333 * decorations above the window, for both cases where the window itself
7334 * is being position inside of them or the window is being placed under
7335 * then and covered insets are used for the window to position its content
7336 * inside. In effect, this tells you the available area where content can
7337 * be placed and remain visible to users.
7338 *
7339 * <p>This function requires an IPC back to the window manager to retrieve
7340 * the requested information, so should not be used in performance critical
7341 * code like drawing.
7342 *
7343 * @param outRect Filled in with the visible display frame. If the view
7344 * is not attached to a window, this is simply the raw display size.
7345 */
7346 public void getWindowVisibleDisplayFrame(Rect outRect) {
7347 if (mAttachInfo != null) {
7348 try {
7349 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect);
7350 } catch (RemoteException e) {
7351 return;
7352 }
7353 // XXX This is really broken, and probably all needs to be done
7354 // in the window manager, and we need to know more about whether
7355 // we want the area behind or in front of the IME.
7356 final Rect insets = mAttachInfo.mVisibleInsets;
7357 outRect.left += insets.left;
7358 outRect.top += insets.top;
7359 outRect.right -= insets.right;
7360 outRect.bottom -= insets.bottom;
7361 return;
7362 }
Jeff Brownbd6e1502012-08-28 03:27:37 -07007363 // The view is not attached to a display so we don't have a context.
7364 // Make a best guess about the display size.
7365 Display d = DisplayManagerGlobal.getInstance().getRealDisplay(Display.DEFAULT_DISPLAY);
Dianne Hackborn44bc17c2011-04-20 18:18:51 -07007366 d.getRectSize(outRect);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007367 }
7368
7369 /**
Dianne Hackborne36d6e22010-02-17 19:46:25 -08007370 * Dispatch a notification about a resource configuration change down
7371 * the view hierarchy.
7372 * ViewGroups should override to route to their children.
7373 *
7374 * @param newConfig The new resource configuration.
7375 *
Philip Milne6c8ea062012-04-03 17:38:43 -07007376 * @see #onConfigurationChanged(android.content.res.Configuration)
Dianne Hackborne36d6e22010-02-17 19:46:25 -08007377 */
7378 public void dispatchConfigurationChanged(Configuration newConfig) {
7379 onConfigurationChanged(newConfig);
7380 }
7381
7382 /**
7383 * Called when the current configuration of the resources being used
7384 * by the application have changed. You can use this to decide when
7385 * to reload resources that can changed based on orientation and other
7386 * configuration characterstics. You only need to use this if you are
7387 * not relying on the normal {@link android.app.Activity} mechanism of
7388 * recreating the activity instance upon a configuration change.
7389 *
7390 * @param newConfig The new resource configuration.
7391 */
7392 protected void onConfigurationChanged(Configuration newConfig) {
7393 }
7394
7395 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007396 * Private function to aggregate all per-view attributes in to the view
7397 * root.
7398 */
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007399 void dispatchCollectViewAttributes(AttachInfo attachInfo, int visibility) {
7400 performCollectViewAttributes(attachInfo, visibility);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007401 }
7402
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007403 void performCollectViewAttributes(AttachInfo attachInfo, int visibility) {
7404 if ((visibility & VISIBILITY_MASK) == VISIBLE) {
Joe Onorato664644d2011-01-23 17:53:23 -08007405 if ((mViewFlags & KEEP_SCREEN_ON) == KEEP_SCREEN_ON) {
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007406 attachInfo.mKeepScreenOn = true;
Joe Onorato664644d2011-01-23 17:53:23 -08007407 }
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007408 attachInfo.mSystemUiVisibility |= mSystemUiVisibility;
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07007409 ListenerInfo li = mListenerInfo;
7410 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) {
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007411 attachInfo.mHasSystemUiListeners = true;
Joe Onorato664644d2011-01-23 17:53:23 -08007412 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007413 }
7414 }
7415
7416 void needGlobalAttributesUpdate(boolean force) {
Joe Onorato664644d2011-01-23 17:53:23 -08007417 final AttachInfo ai = mAttachInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007418 if (ai != null) {
Joe Onorato664644d2011-01-23 17:53:23 -08007419 if (force || ai.mKeepScreenOn || (ai.mSystemUiVisibility != 0)
7420 || ai.mHasSystemUiListeners) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007421 ai.mRecomputeGlobalAttributes = true;
7422 }
7423 }
7424 }
7425
7426 /**
7427 * Returns whether the device is currently in touch mode. Touch mode is entered
7428 * once the user begins interacting with the device by touch, and affects various
7429 * things like whether focus is always visible to the user.
7430 *
7431 * @return Whether the device is in touch mode.
7432 */
7433 @ViewDebug.ExportedProperty
7434 public boolean isInTouchMode() {
7435 if (mAttachInfo != null) {
7436 return mAttachInfo.mInTouchMode;
7437 } else {
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07007438 return ViewRootImpl.isInTouchMode();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007439 }
7440 }
7441
7442 /**
7443 * Returns the context the view is running in, through which it can
7444 * access the current theme, resources, etc.
7445 *
7446 * @return The view's Context.
7447 */
7448 @ViewDebug.CapturedViewProperty
7449 public final Context getContext() {
7450 return mContext;
7451 }
7452
7453 /**
7454 * Handle a key event before it is processed by any input method
7455 * associated with the view hierarchy. This can be used to intercept
7456 * key events in special situations before the IME consumes them; a
7457 * typical example would be handling the BACK key to update the application's
7458 * UI instead of allowing the IME to see it and close itself.
7459 *
7460 * @param keyCode The value in event.getKeyCode().
7461 * @param event Description of the key event.
7462 * @return If you handled the event, return true. If you want to allow the
7463 * event to be handled by the next receiver, return false.
7464 */
7465 public boolean onKeyPreIme(int keyCode, KeyEvent event) {
7466 return false;
7467 }
7468
7469 /**
Jeff Brown995e7742010-12-22 16:59:36 -08007470 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent)
7471 * KeyEvent.Callback.onKeyDown()}: perform press of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007472 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER}
7473 * is released, if the view is enabled and clickable.
7474 *
Jean Chalard405bc512012-05-29 19:12:34 +09007475 * <p>Key presses in software keyboards will generally NOT trigger this listener,
7476 * although some may elect to do so in some situations. Do not rely on this to
7477 * catch software key presses.
7478 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007479 * @param keyCode A key code that represents the button pressed, from
7480 * {@link android.view.KeyEvent}.
7481 * @param event The KeyEvent object that defines the button action.
7482 */
7483 public boolean onKeyDown(int keyCode, KeyEvent event) {
7484 boolean result = false;
7485
7486 switch (keyCode) {
7487 case KeyEvent.KEYCODE_DPAD_CENTER:
7488 case KeyEvent.KEYCODE_ENTER: {
7489 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
7490 return true;
7491 }
7492 // Long clickable items don't necessarily have to be clickable
7493 if (((mViewFlags & CLICKABLE) == CLICKABLE ||
7494 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) &&
7495 (event.getRepeatCount() == 0)) {
7496 setPressed(true);
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007497 checkForLongClick(0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007498 return true;
7499 }
7500 break;
7501 }
7502 }
7503 return result;
7504 }
7505
7506 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07007507 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
7508 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle
7509 * the event).
Jean Chalard405bc512012-05-29 19:12:34 +09007510 * <p>Key presses in software keyboards will generally NOT trigger this listener,
7511 * although some may elect to do so in some situations. Do not rely on this to
7512 * catch software key presses.
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07007513 */
7514 public boolean onKeyLongPress(int keyCode, KeyEvent event) {
7515 return false;
7516 }
7517
7518 /**
Jeff Brown995e7742010-12-22 16:59:36 -08007519 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent)
7520 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007521 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or
7522 * {@link KeyEvent#KEYCODE_ENTER} is released.
Jean Chalard405bc512012-05-29 19:12:34 +09007523 * <p>Key presses in software keyboards will generally NOT trigger this listener,
7524 * although some may elect to do so in some situations. Do not rely on this to
7525 * catch software key presses.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007526 *
7527 * @param keyCode A key code that represents the button pressed, from
7528 * {@link android.view.KeyEvent}.
7529 * @param event The KeyEvent object that defines the button action.
7530 */
7531 public boolean onKeyUp(int keyCode, KeyEvent event) {
7532 boolean result = false;
7533
7534 switch (keyCode) {
7535 case KeyEvent.KEYCODE_DPAD_CENTER:
7536 case KeyEvent.KEYCODE_ENTER: {
7537 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
7538 return true;
7539 }
7540 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) {
7541 setPressed(false);
7542
7543 if (!mHasPerformedLongPress) {
7544 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05007545 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007546
7547 result = performClick();
7548 }
7549 }
7550 break;
7551 }
7552 }
7553 return result;
7554 }
7555
7556 /**
7557 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
7558 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle
7559 * the event).
Jean Chalard405bc512012-05-29 19:12:34 +09007560 * <p>Key presses in software keyboards will generally NOT trigger this listener,
7561 * although some may elect to do so in some situations. Do not rely on this to
7562 * catch software key presses.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007563 *
7564 * @param keyCode A key code that represents the button pressed, from
7565 * {@link android.view.KeyEvent}.
7566 * @param repeatCount The number of times the action was made.
7567 * @param event The KeyEvent object that defines the button action.
7568 */
7569 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
7570 return false;
7571 }
7572
7573 /**
Jeff Brown64da12a2011-01-04 19:57:47 -08007574 * Called on the focused view when a key shortcut event is not handled.
7575 * Override this method to implement local key shortcuts for the View.
7576 * Key shortcuts can also be implemented by setting the
7577 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007578 *
7579 * @param keyCode The value in event.getKeyCode().
7580 * @param event Description of the key event.
7581 * @return If you handled the event, return true. If you want to allow the
7582 * event to be handled by the next receiver, return false.
7583 */
7584 public boolean onKeyShortcut(int keyCode, KeyEvent event) {
7585 return false;
7586 }
7587
7588 /**
7589 * Check whether the called view is a text editor, in which case it
7590 * would make sense to automatically display a soft input window for
7591 * it. Subclasses should override this if they implement
7592 * {@link #onCreateInputConnection(EditorInfo)} to return true if
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007593 * a call on that method would return a non-null InputConnection, and
7594 * they are really a first-class editor that the user would normally
7595 * start typing on when the go into a window containing your view.
Romain Guy8506ab42009-06-11 17:35:47 -07007596 *
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007597 * <p>The default implementation always returns false. This does
7598 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)}
7599 * will not be called or the user can not otherwise perform edits on your
7600 * view; it is just a hint to the system that this is not the primary
7601 * purpose of this view.
Romain Guy8506ab42009-06-11 17:35:47 -07007602 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007603 * @return Returns true if this view is a text editor, else false.
7604 */
7605 public boolean onCheckIsTextEditor() {
7606 return false;
7607 }
Romain Guy8506ab42009-06-11 17:35:47 -07007608
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007609 /**
7610 * Create a new InputConnection for an InputMethod to interact
7611 * with the view. The default implementation returns null, since it doesn't
7612 * support input methods. You can override this to implement such support.
7613 * This is only needed for views that take focus and text input.
Romain Guy8506ab42009-06-11 17:35:47 -07007614 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007615 * <p>When implementing this, you probably also want to implement
7616 * {@link #onCheckIsTextEditor()} to indicate you will return a
7617 * non-null InputConnection.
7618 *
7619 * @param outAttrs Fill in with attribute information about the connection.
7620 */
7621 public InputConnection onCreateInputConnection(EditorInfo outAttrs) {
7622 return null;
7623 }
7624
7625 /**
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007626 * Called by the {@link android.view.inputmethod.InputMethodManager}
7627 * when a view who is not the current
7628 * input connection target is trying to make a call on the manager. The
7629 * default implementation returns false; you can override this to return
7630 * true for certain views if you are performing InputConnection proxying
7631 * to them.
7632 * @param view The View that is making the InputMethodManager call.
7633 * @return Return true to allow the call, false to reject.
7634 */
7635 public boolean checkInputConnectionProxy(View view) {
7636 return false;
7637 }
Romain Guy8506ab42009-06-11 17:35:47 -07007638
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007639 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007640 * Show the context menu for this view. It is not safe to hold on to the
7641 * menu after returning from this method.
7642 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07007643 * You should normally not overload this method. Overload
7644 * {@link #onCreateContextMenu(ContextMenu)} or define an
7645 * {@link OnCreateContextMenuListener} to add items to the context menu.
7646 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007647 * @param menu The context menu to populate
7648 */
7649 public void createContextMenu(ContextMenu menu) {
7650 ContextMenuInfo menuInfo = getContextMenuInfo();
7651
7652 // Sets the current menu info so all items added to menu will have
7653 // my extra info set.
7654 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo);
7655
7656 onCreateContextMenu(menu);
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07007657 ListenerInfo li = mListenerInfo;
7658 if (li != null && li.mOnCreateContextMenuListener != null) {
7659 li.mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007660 }
7661
7662 // Clear the extra information so subsequent items that aren't mine don't
7663 // have my extra info.
7664 ((MenuBuilder)menu).setCurrentMenuInfo(null);
7665
7666 if (mParent != null) {
7667 mParent.createContextMenu(menu);
7668 }
7669 }
7670
7671 /**
7672 * Views should implement this if they have extra information to associate
7673 * with the context menu. The return result is supplied as a parameter to
7674 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)}
7675 * callback.
7676 *
7677 * @return Extra information about the item for which the context menu
7678 * should be shown. This information will vary across different
7679 * subclasses of View.
7680 */
7681 protected ContextMenuInfo getContextMenuInfo() {
7682 return null;
7683 }
7684
7685 /**
7686 * Views should implement this if the view itself is going to add items to
7687 * the context menu.
7688 *
7689 * @param menu the context menu to populate
7690 */
7691 protected void onCreateContextMenu(ContextMenu menu) {
7692 }
7693
7694 /**
7695 * Implement this method to handle trackball motion events. The
7696 * <em>relative</em> movement of the trackball since the last event
7697 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and
7698 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so
7699 * that a movement of 1 corresponds to the user pressing one DPAD key (so
7700 * they will often be fractional values, representing the more fine-grained
7701 * movement information available from a trackball).
7702 *
7703 * @param event The motion event.
7704 * @return True if the event was handled, false otherwise.
7705 */
7706 public boolean onTrackballEvent(MotionEvent event) {
7707 return false;
7708 }
7709
7710 /**
Jeff Browncb1404e2011-01-15 18:14:15 -08007711 * Implement this method to handle generic motion events.
7712 * <p>
Jeff Brown33bbfd22011-02-24 20:55:35 -08007713 * Generic motion events describe joystick movements, mouse hovers, track pad
7714 * touches, scroll wheel movements and other input events. The
Jeff Browncb1404e2011-01-15 18:14:15 -08007715 * {@link MotionEvent#getSource() source} of the motion event specifies
7716 * the class of input that was received. Implementations of this method
7717 * must examine the bits in the source before processing the event.
7718 * The following code example shows how this is done.
Jeff Brown33bbfd22011-02-24 20:55:35 -08007719 * </p><p>
7720 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER}
7721 * are delivered to the view under the pointer. All other generic motion events are
7722 * delivered to the focused view.
Jeff Browncb1404e2011-01-15 18:14:15 -08007723 * </p>
Scott Mainb303d832011-10-12 16:45:18 -07007724 * <pre> public boolean onGenericMotionEvent(MotionEvent event) {
Jeff Browncb1404e2011-01-15 18:14:15 -08007725 * if ((event.getSource() &amp; InputDevice.SOURCE_CLASS_JOYSTICK) != 0) {
Jeff Brown33bbfd22011-02-24 20:55:35 -08007726 * if (event.getAction() == MotionEvent.ACTION_MOVE) {
7727 * // process the joystick movement...
7728 * return true;
7729 * }
7730 * }
7731 * if ((event.getSource() &amp; InputDevice.SOURCE_CLASS_POINTER) != 0) {
7732 * switch (event.getAction()) {
7733 * case MotionEvent.ACTION_HOVER_MOVE:
7734 * // process the mouse hover movement...
7735 * return true;
7736 * case MotionEvent.ACTION_SCROLL:
7737 * // process the scroll wheel movement...
7738 * return true;
7739 * }
Jeff Browncb1404e2011-01-15 18:14:15 -08007740 * }
7741 * return super.onGenericMotionEvent(event);
Scott Mainb303d832011-10-12 16:45:18 -07007742 * }</pre>
Jeff Browncb1404e2011-01-15 18:14:15 -08007743 *
7744 * @param event The generic motion event being processed.
Jeff Browna032cc02011-03-07 16:56:21 -08007745 * @return True if the event was handled, false otherwise.
Jeff Browncb1404e2011-01-15 18:14:15 -08007746 */
7747 public boolean onGenericMotionEvent(MotionEvent event) {
7748 return false;
7749 }
7750
7751 /**
Jeff Browna032cc02011-03-07 16:56:21 -08007752 * Implement this method to handle hover events.
7753 * <p>
Jeff Brown10b62902011-06-20 16:40:37 -07007754 * This method is called whenever a pointer is hovering into, over, or out of the
7755 * bounds of a view and the view is not currently being touched.
7756 * Hover events are represented as pointer events with action
7757 * {@link MotionEvent#ACTION_HOVER_ENTER}, {@link MotionEvent#ACTION_HOVER_MOVE},
7758 * or {@link MotionEvent#ACTION_HOVER_EXIT}.
7759 * </p>
7760 * <ul>
7761 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_ENTER}
7762 * when the pointer enters the bounds of the view.</li>
7763 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_MOVE}
7764 * when the pointer has already entered the bounds of the view and has moved.</li>
7765 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_EXIT}
7766 * when the pointer has exited the bounds of the view or when the pointer is
7767 * about to go down due to a button click, tap, or similar user action that
7768 * causes the view to be touched.</li>
7769 * </ul>
7770 * <p>
7771 * The view should implement this method to return true to indicate that it is
7772 * handling the hover event, such as by changing its drawable state.
Jeff Browna032cc02011-03-07 16:56:21 -08007773 * </p><p>
Jeff Brown10b62902011-06-20 16:40:37 -07007774 * The default implementation calls {@link #setHovered} to update the hovered state
7775 * of the view when a hover enter or hover exit event is received, if the view
Jeff Browna1b24182011-07-28 13:38:24 -07007776 * is enabled and is clickable. The default implementation also sends hover
7777 * accessibility events.
Jeff Browna032cc02011-03-07 16:56:21 -08007778 * </p>
7779 *
7780 * @param event The motion event that describes the hover.
Jeff Brown10b62902011-06-20 16:40:37 -07007781 * @return True if the view handled the hover event.
7782 *
7783 * @see #isHovered
7784 * @see #setHovered
7785 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08007786 */
7787 public boolean onHoverEvent(MotionEvent event) {
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007788 // The root view may receive hover (or touch) events that are outside the bounds of
7789 // the window. This code ensures that we only send accessibility events for
7790 // hovers that are actually within the bounds of the root view.
Svetoslav Ganov42138042012-03-20 11:51:39 -07007791 final int action = event.getActionMasked();
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007792 if (!mSendingHoverAccessibilityEvents) {
7793 if ((action == MotionEvent.ACTION_HOVER_ENTER
7794 || action == MotionEvent.ACTION_HOVER_MOVE)
7795 && !hasHoveredChild()
7796 && pointInView(event.getX(), event.getY())) {
Svetoslav Ganov8ffe8b32012-06-15 10:31:31 -07007797 sendAccessibilityHoverEvent(AccessibilityEvent.TYPE_VIEW_HOVER_ENTER);
Svetoslav Ganov42138042012-03-20 11:51:39 -07007798 mSendingHoverAccessibilityEvents = true;
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007799 }
7800 } else {
7801 if (action == MotionEvent.ACTION_HOVER_EXIT
Svetoslav Ganov42138042012-03-20 11:51:39 -07007802 || (action == MotionEvent.ACTION_MOVE
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007803 && !pointInView(event.getX(), event.getY()))) {
7804 mSendingHoverAccessibilityEvents = false;
Svetoslav Ganov8ffe8b32012-06-15 10:31:31 -07007805 sendAccessibilityHoverEvent(AccessibilityEvent.TYPE_VIEW_HOVER_EXIT);
Svetoslav Ganov42138042012-03-20 11:51:39 -07007806 // If the window does not have input focus we take away accessibility
7807 // focus as soon as the user stop hovering over the view.
Jeff Brown59a422e2012-04-19 15:19:19 -07007808 if (mAttachInfo != null && !mAttachInfo.mHasWindowFocus) {
Svetoslav Ganov45a02e02012-06-17 15:07:29 -07007809 getViewRootImpl().setAccessibilityFocus(null, null);
Svetoslav Ganov42138042012-03-20 11:51:39 -07007810 }
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007811 }
Jeff Browna1b24182011-07-28 13:38:24 -07007812 }
7813
Jeff Brown87b7f802011-06-21 18:35:45 -07007814 if (isHoverable()) {
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007815 switch (action) {
Jeff Brown10b62902011-06-20 16:40:37 -07007816 case MotionEvent.ACTION_HOVER_ENTER:
7817 setHovered(true);
7818 break;
7819 case MotionEvent.ACTION_HOVER_EXIT:
7820 setHovered(false);
7821 break;
7822 }
Jeff Browna1b24182011-07-28 13:38:24 -07007823
7824 // Dispatch the event to onGenericMotionEvent before returning true.
7825 // This is to provide compatibility with existing applications that
7826 // handled HOVER_MOVE events in onGenericMotionEvent and that would
7827 // break because of the new default handling for hoverable views
7828 // in onHoverEvent.
7829 // Note that onGenericMotionEvent will be called by default when
7830 // onHoverEvent returns false (refer to dispatchGenericMotionEvent).
7831 dispatchGenericMotionEventInternal(event);
Jeff Brown10b62902011-06-20 16:40:37 -07007832 return true;
Jeff Browna032cc02011-03-07 16:56:21 -08007833 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07007834
Svetoslav Ganov736c2752011-04-22 18:30:36 -07007835 return false;
Jeff Browna032cc02011-03-07 16:56:21 -08007836 }
7837
7838 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07007839 * Returns true if the view should handle {@link #onHoverEvent}
7840 * by calling {@link #setHovered} to change its hovered state.
7841 *
7842 * @return True if the view is hoverable.
7843 */
7844 private boolean isHoverable() {
7845 final int viewFlags = mViewFlags;
7846 if ((viewFlags & ENABLED_MASK) == DISABLED) {
7847 return false;
7848 }
7849
7850 return (viewFlags & CLICKABLE) == CLICKABLE
7851 || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
7852 }
7853
7854 /**
Jeff Browna032cc02011-03-07 16:56:21 -08007855 * Returns true if the view is currently hovered.
7856 *
7857 * @return True if the view is currently hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07007858 *
7859 * @see #setHovered
7860 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08007861 */
Jeff Brown10b62902011-06-20 16:40:37 -07007862 @ViewDebug.ExportedProperty
Jeff Browna032cc02011-03-07 16:56:21 -08007863 public boolean isHovered() {
Dianne Hackborn4702a852012-08-17 15:18:29 -07007864 return (mPrivateFlags & PFLAG_HOVERED) != 0;
Jeff Browna032cc02011-03-07 16:56:21 -08007865 }
7866
7867 /**
7868 * Sets whether the view is currently hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07007869 * <p>
7870 * Calling this method also changes the drawable state of the view. This
7871 * enables the view to react to hover by using different drawable resources
7872 * to change its appearance.
7873 * </p><p>
7874 * The {@link #onHoverChanged} method is called when the hovered state changes.
7875 * </p>
Jeff Browna032cc02011-03-07 16:56:21 -08007876 *
7877 * @param hovered True if the view is hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07007878 *
7879 * @see #isHovered
7880 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08007881 */
7882 public void setHovered(boolean hovered) {
7883 if (hovered) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07007884 if ((mPrivateFlags & PFLAG_HOVERED) == 0) {
7885 mPrivateFlags |= PFLAG_HOVERED;
Jeff Browna032cc02011-03-07 16:56:21 -08007886 refreshDrawableState();
Jeff Brown10b62902011-06-20 16:40:37 -07007887 onHoverChanged(true);
Jeff Browna032cc02011-03-07 16:56:21 -08007888 }
7889 } else {
Dianne Hackborn4702a852012-08-17 15:18:29 -07007890 if ((mPrivateFlags & PFLAG_HOVERED) != 0) {
7891 mPrivateFlags &= ~PFLAG_HOVERED;
Jeff Browna032cc02011-03-07 16:56:21 -08007892 refreshDrawableState();
Jeff Brown10b62902011-06-20 16:40:37 -07007893 onHoverChanged(false);
Jeff Browna032cc02011-03-07 16:56:21 -08007894 }
7895 }
7896 }
7897
7898 /**
Jeff Brown10b62902011-06-20 16:40:37 -07007899 * Implement this method to handle hover state changes.
7900 * <p>
7901 * This method is called whenever the hover state changes as a result of a
7902 * call to {@link #setHovered}.
7903 * </p>
7904 *
7905 * @param hovered The current hover state, as returned by {@link #isHovered}.
7906 *
7907 * @see #isHovered
7908 * @see #setHovered
7909 */
7910 public void onHoverChanged(boolean hovered) {
Jeff Brown10b62902011-06-20 16:40:37 -07007911 }
7912
7913 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007914 * Implement this method to handle touch screen motion events.
7915 *
7916 * @param event The motion event.
7917 * @return True if the event was handled, false otherwise.
7918 */
7919 public boolean onTouchEvent(MotionEvent event) {
7920 final int viewFlags = mViewFlags;
7921
7922 if ((viewFlags & ENABLED_MASK) == DISABLED) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07007923 if (event.getAction() == MotionEvent.ACTION_UP && (mPrivateFlags & PFLAG_PRESSED) != 0) {
Adam Powell4d6f0662012-02-21 15:11:11 -08007924 setPressed(false);
Svetoslav Ganov77b80c02011-03-15 20:52:58 -07007925 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007926 // A disabled view that is clickable still consumes the touch
7927 // events, it just doesn't respond to them.
7928 return (((viewFlags & CLICKABLE) == CLICKABLE ||
7929 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE));
7930 }
7931
7932 if (mTouchDelegate != null) {
7933 if (mTouchDelegate.onTouchEvent(event)) {
7934 return true;
7935 }
7936 }
7937
7938 if (((viewFlags & CLICKABLE) == CLICKABLE ||
7939 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) {
7940 switch (event.getAction()) {
7941 case MotionEvent.ACTION_UP:
Dianne Hackborn4702a852012-08-17 15:18:29 -07007942 boolean prepressed = (mPrivateFlags & PFLAG_PREPRESSED) != 0;
7943 if ((mPrivateFlags & PFLAG_PRESSED) != 0 || prepressed) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007944 // take focus if we don't have it already and we should in
7945 // touch mode.
7946 boolean focusTaken = false;
7947 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) {
7948 focusTaken = requestFocus();
7949 }
7950
Dianne Hackbornbe1f6222011-01-20 15:24:28 -08007951 if (prepressed) {
7952 // The button is being released before we actually
7953 // showed it as pressed. Make it show the pressed
7954 // state now (before scheduling the click) to ensure
7955 // the user sees it.
Adam Powell4d6f0662012-02-21 15:11:11 -08007956 setPressed(true);
Dianne Hackbornbe1f6222011-01-20 15:24:28 -08007957 }
Joe Malin32736f02011-01-19 16:14:20 -08007958
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007959 if (!mHasPerformedLongPress) {
7960 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05007961 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007962
7963 // Only perform take click actions if we were in the pressed state
7964 if (!focusTaken) {
Adam Powella35d7682010-03-12 14:48:13 -08007965 // Use a Runnable and post this rather than calling
7966 // performClick directly. This lets other visual state
7967 // of the view update before click actions start.
7968 if (mPerformClick == null) {
7969 mPerformClick = new PerformClick();
7970 }
7971 if (!post(mPerformClick)) {
7972 performClick();
7973 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007974 }
7975 }
7976
7977 if (mUnsetPressedState == null) {
7978 mUnsetPressedState = new UnsetPressedState();
7979 }
7980
Adam Powelle14579b2009-12-16 18:39:52 -08007981 if (prepressed) {
Adam Powelle14579b2009-12-16 18:39:52 -08007982 postDelayed(mUnsetPressedState,
7983 ViewConfiguration.getPressedStateDuration());
7984 } else if (!post(mUnsetPressedState)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007985 // If the post failed, unpress right now
7986 mUnsetPressedState.run();
7987 }
Adam Powelle14579b2009-12-16 18:39:52 -08007988 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007989 }
7990 break;
7991
7992 case MotionEvent.ACTION_DOWN:
Adam Powell3b023392010-03-11 16:30:28 -08007993 mHasPerformedLongPress = false;
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007994
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07007995 if (performButtonActionOnTouchDown(event)) {
7996 break;
7997 }
7998
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007999 // Walk up the hierarchy to determine if we're inside a scrolling container.
Adam Powell10298662011-08-14 18:26:30 -07008000 boolean isInScrollingContainer = isInScrollingContainer();
Patrick Dubroye0a799a2011-05-04 16:19:22 -07008001
8002 // For views inside a scrolling container, delay the pressed feedback for
8003 // a short period in case this is a scroll.
8004 if (isInScrollingContainer) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07008005 mPrivateFlags |= PFLAG_PREPRESSED;
Patrick Dubroye0a799a2011-05-04 16:19:22 -07008006 if (mPendingCheckForTap == null) {
8007 mPendingCheckForTap = new CheckForTap();
8008 }
8009 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout());
8010 } else {
8011 // Not inside a scrolling container, so show the feedback right away
Adam Powell4d6f0662012-02-21 15:11:11 -08008012 setPressed(true);
Patrick Dubroye0a799a2011-05-04 16:19:22 -07008013 checkForLongClick(0);
8014 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008015 break;
8016
8017 case MotionEvent.ACTION_CANCEL:
Adam Powell4d6f0662012-02-21 15:11:11 -08008018 setPressed(false);
Adam Powelle14579b2009-12-16 18:39:52 -08008019 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008020 break;
8021
8022 case MotionEvent.ACTION_MOVE:
8023 final int x = (int) event.getX();
8024 final int y = (int) event.getY();
8025
8026 // Be lenient about moving outside of buttons
Chet Haasec3aa3612010-06-17 08:50:37 -07008027 if (!pointInView(x, y, mTouchSlop)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008028 // Outside button
Adam Powelle14579b2009-12-16 18:39:52 -08008029 removeTapCallback();
Dianne Hackborn4702a852012-08-17 15:18:29 -07008030 if ((mPrivateFlags & PFLAG_PRESSED) != 0) {
Adam Powelle14579b2009-12-16 18:39:52 -08008031 // Remove any future long press/tap checks
Maryam Garrett1549dd12009-12-15 16:06:36 -05008032 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008033
Adam Powell4d6f0662012-02-21 15:11:11 -08008034 setPressed(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008035 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008036 }
8037 break;
8038 }
8039 return true;
8040 }
8041
8042 return false;
8043 }
8044
8045 /**
Adam Powell10298662011-08-14 18:26:30 -07008046 * @hide
8047 */
8048 public boolean isInScrollingContainer() {
8049 ViewParent p = getParent();
8050 while (p != null && p instanceof ViewGroup) {
8051 if (((ViewGroup) p).shouldDelayChildPressedState()) {
8052 return true;
8053 }
8054 p = p.getParent();
8055 }
8056 return false;
8057 }
8058
8059 /**
Maryam Garrett1549dd12009-12-15 16:06:36 -05008060 * Remove the longpress detection timer.
8061 */
8062 private void removeLongPressCallback() {
8063 if (mPendingCheckForLongPress != null) {
8064 removeCallbacks(mPendingCheckForLongPress);
8065 }
8066 }
Adam Powell3cb8b632011-01-21 15:34:14 -08008067
8068 /**
8069 * Remove the pending click action
8070 */
8071 private void removePerformClickCallback() {
8072 if (mPerformClick != null) {
8073 removeCallbacks(mPerformClick);
8074 }
8075 }
8076
Adam Powelle14579b2009-12-16 18:39:52 -08008077 /**
Romain Guya440b002010-02-24 15:57:54 -08008078 * Remove the prepress detection timer.
8079 */
8080 private void removeUnsetPressCallback() {
Dianne Hackborn4702a852012-08-17 15:18:29 -07008081 if ((mPrivateFlags & PFLAG_PRESSED) != 0 && mUnsetPressedState != null) {
Romain Guya440b002010-02-24 15:57:54 -08008082 setPressed(false);
8083 removeCallbacks(mUnsetPressedState);
8084 }
8085 }
8086
8087 /**
Adam Powelle14579b2009-12-16 18:39:52 -08008088 * Remove the tap detection timer.
8089 */
8090 private void removeTapCallback() {
8091 if (mPendingCheckForTap != null) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07008092 mPrivateFlags &= ~PFLAG_PREPRESSED;
Adam Powelle14579b2009-12-16 18:39:52 -08008093 removeCallbacks(mPendingCheckForTap);
8094 }
8095 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05008096
8097 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008098 * Cancels a pending long press. Your subclass can use this if you
8099 * want the context menu to come up if the user presses and holds
8100 * at the same place, but you don't want it to come up if they press
8101 * and then move around enough to cause scrolling.
8102 */
8103 public void cancelLongPress() {
Maryam Garrett1549dd12009-12-15 16:06:36 -05008104 removeLongPressCallback();
Adam Powell732ebb12010-02-02 15:28:14 -08008105
8106 /*
8107 * The prepressed state handled by the tap callback is a display
8108 * construct, but the tap callback will post a long press callback
8109 * less its own timeout. Remove it here.
8110 */
8111 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008112 }
8113
8114 /**
Svetoslav Ganova0156172011-06-26 17:55:44 -07008115 * Remove the pending callback for sending a
8116 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event.
8117 */
8118 private void removeSendViewScrolledAccessibilityEventCallback() {
8119 if (mSendViewScrolledAccessibilityEvent != null) {
8120 removeCallbacks(mSendViewScrolledAccessibilityEvent);
Svetoslav Ganov4a812ae2012-05-29 16:46:10 -07008121 mSendViewScrolledAccessibilityEvent.mIsPending = false;
Svetoslav Ganova0156172011-06-26 17:55:44 -07008122 }
8123 }
8124
8125 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008126 * Sets the TouchDelegate for this View.
8127 */
8128 public void setTouchDelegate(TouchDelegate delegate) {
8129 mTouchDelegate = delegate;
8130 }
8131
8132 /**
8133 * Gets the TouchDelegate for this View.
8134 */
8135 public TouchDelegate getTouchDelegate() {
8136 return mTouchDelegate;
8137 }
8138
8139 /**
8140 * Set flags controlling behavior of this view.
8141 *
8142 * @param flags Constant indicating the value which should be set
8143 * @param mask Constant indicating the bit range that should be changed
8144 */
8145 void setFlags(int flags, int mask) {
8146 int old = mViewFlags;
8147 mViewFlags = (mViewFlags & ~mask) | (flags & mask);
8148
8149 int changed = mViewFlags ^ old;
8150 if (changed == 0) {
8151 return;
8152 }
8153 int privateFlags = mPrivateFlags;
8154
8155 /* Check if the FOCUSABLE bit has changed */
8156 if (((changed & FOCUSABLE_MASK) != 0) &&
Dianne Hackborn4702a852012-08-17 15:18:29 -07008157 ((privateFlags & PFLAG_HAS_BOUNDS) !=0)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008158 if (((old & FOCUSABLE_MASK) == FOCUSABLE)
Dianne Hackborn4702a852012-08-17 15:18:29 -07008159 && ((privateFlags & PFLAG_FOCUSED) != 0)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008160 /* Give up focus if we are no longer focusable */
8161 clearFocus();
8162 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE)
Dianne Hackborn4702a852012-08-17 15:18:29 -07008163 && ((privateFlags & PFLAG_FOCUSED) == 0)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008164 /*
8165 * Tell the view system that we are now available to take focus
8166 * if no one else already has it.
8167 */
8168 if (mParent != null) mParent.focusableViewAvailable(this);
8169 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07008170 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
8171 notifyAccessibilityStateChanged();
8172 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008173 }
8174
8175 if ((flags & VISIBILITY_MASK) == VISIBLE) {
8176 if ((changed & VISIBILITY_MASK) != 0) {
8177 /*
Chet Haase4324ead2011-08-24 21:31:03 -07008178 * If this view is becoming visible, invalidate it in case it changed while
Chet Haaseaceafe62011-08-26 15:44:33 -07008179 * it was not visible. Marking it drawn ensures that the invalidation will
8180 * go through.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008181 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07008182 mPrivateFlags |= PFLAG_DRAWN;
Chet Haase4324ead2011-08-24 21:31:03 -07008183 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008184
8185 needGlobalAttributesUpdate(true);
8186
8187 // a view becoming visible is worth notifying the parent
8188 // about in case nothing has focus. even if this specific view
8189 // isn't focusable, it may contain something that is, so let
8190 // the root view try to give this focus if nothing else does.
8191 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) {
8192 mParent.focusableViewAvailable(this);
8193 }
8194 }
8195 }
8196
8197 /* Check if the GONE bit has changed */
8198 if ((changed & GONE) != 0) {
8199 needGlobalAttributesUpdate(false);
8200 requestLayout();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008201
Romain Guyecd80ee2009-12-03 17:13:02 -08008202 if (((mViewFlags & VISIBILITY_MASK) == GONE)) {
8203 if (hasFocus()) clearFocus();
Svetoslav Ganov42138042012-03-20 11:51:39 -07008204 clearAccessibilityFocus();
Romain Guyecd80ee2009-12-03 17:13:02 -08008205 destroyDrawingCache();
Chet Haaseaceafe62011-08-26 15:44:33 -07008206 if (mParent instanceof View) {
8207 // GONE views noop invalidation, so invalidate the parent
8208 ((View) mParent).invalidate(true);
8209 }
8210 // Mark the view drawn to ensure that it gets invalidated properly the next
8211 // time it is visible and gets invalidated
Dianne Hackborn4702a852012-08-17 15:18:29 -07008212 mPrivateFlags |= PFLAG_DRAWN;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008213 }
8214 if (mAttachInfo != null) {
8215 mAttachInfo.mViewVisibilityChanged = true;
8216 }
8217 }
8218
8219 /* Check if the VISIBLE bit has changed */
8220 if ((changed & INVISIBLE) != 0) {
8221 needGlobalAttributesUpdate(false);
Chet Haasec8a9a702011-06-17 12:13:42 -07008222 /*
8223 * If this view is becoming invisible, set the DRAWN flag so that
8224 * the next invalidate() will not be skipped.
8225 */
Dianne Hackborn4702a852012-08-17 15:18:29 -07008226 mPrivateFlags |= PFLAG_DRAWN;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008227
8228 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07008229 // root view becoming invisible shouldn't clear focus and accessibility focus
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008230 if (getRootView() != this) {
8231 clearFocus();
Svetoslav Ganov42138042012-03-20 11:51:39 -07008232 clearAccessibilityFocus();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008233 }
8234 }
8235 if (mAttachInfo != null) {
8236 mAttachInfo.mViewVisibilityChanged = true;
8237 }
8238 }
8239
Adam Powell326d8082009-12-09 15:10:07 -08008240 if ((changed & VISIBILITY_MASK) != 0) {
Chet Haase5e25c2c2010-09-16 11:15:56 -07008241 if (mParent instanceof ViewGroup) {
Romain Guyfe455af2012-02-15 16:40:20 -08008242 ((ViewGroup) mParent).onChildVisibilityChanged(this,
8243 (changed & VISIBILITY_MASK), (flags & VISIBILITY_MASK));
Romain Guy0fd89bf2011-01-26 15:41:30 -08008244 ((View) mParent).invalidate(true);
Chet Haasee4e6e202011-08-29 14:34:30 -07008245 } else if (mParent != null) {
8246 mParent.invalidateChild(this, null);
Chet Haase5e25c2c2010-09-16 11:15:56 -07008247 }
Adam Powell326d8082009-12-09 15:10:07 -08008248 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK));
8249 }
8250
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008251 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) {
8252 destroyDrawingCache();
8253 }
8254
8255 if ((changed & DRAWING_CACHE_ENABLED) != 0) {
8256 destroyDrawingCache();
Dianne Hackborn4702a852012-08-17 15:18:29 -07008257 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID;
Romain Guy0fd89bf2011-01-26 15:41:30 -08008258 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008259 }
8260
8261 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) {
8262 destroyDrawingCache();
Dianne Hackborn4702a852012-08-17 15:18:29 -07008263 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008264 }
8265
8266 if ((changed & DRAW_MASK) != 0) {
8267 if ((mViewFlags & WILL_NOT_DRAW) != 0) {
Philip Milne6c8ea062012-04-03 17:38:43 -07008268 if (mBackground != null) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07008269 mPrivateFlags &= ~PFLAG_SKIP_DRAW;
8270 mPrivateFlags |= PFLAG_ONLY_DRAWS_BACKGROUND;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008271 } else {
Dianne Hackborn4702a852012-08-17 15:18:29 -07008272 mPrivateFlags |= PFLAG_SKIP_DRAW;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008273 }
8274 } else {
Dianne Hackborn4702a852012-08-17 15:18:29 -07008275 mPrivateFlags &= ~PFLAG_SKIP_DRAW;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008276 }
8277 requestLayout();
Romain Guy0fd89bf2011-01-26 15:41:30 -08008278 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008279 }
8280
8281 if ((changed & KEEP_SCREEN_ON) != 0) {
Joe Onorato664644d2011-01-23 17:53:23 -08008282 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008283 mParent.recomputeViewAttributes(this);
8284 }
8285 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07008286
8287 if (AccessibilityManager.getInstance(mContext).isEnabled()
8288 && ((changed & FOCUSABLE) != 0 || (changed & CLICKABLE) != 0
8289 || (changed & LONG_CLICKABLE) != 0 || (changed & ENABLED) != 0)) {
8290 notifyAccessibilityStateChanged();
8291 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008292 }
8293
8294 /**
8295 * Change the view's z order in the tree, so it's on top of other sibling
8296 * views
8297 */
8298 public void bringToFront() {
8299 if (mParent != null) {
8300 mParent.bringChildToFront(this);
8301 }
8302 }
8303
8304 /**
8305 * This is called in response to an internal scroll in this view (i.e., the
8306 * view scrolled its own contents). This is typically as a result of
8307 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been
8308 * called.
8309 *
8310 * @param l Current horizontal scroll origin.
8311 * @param t Current vertical scroll origin.
8312 * @param oldl Previous horizontal scroll origin.
8313 * @param oldt Previous vertical scroll origin.
8314 */
8315 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
Svetoslav Ganova0156172011-06-26 17:55:44 -07008316 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
8317 postSendViewScrolledAccessibilityEventCallback();
8318 }
8319
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008320 mBackgroundSizeChanged = true;
8321
8322 final AttachInfo ai = mAttachInfo;
8323 if (ai != null) {
8324 ai.mViewScrollChanged = true;
8325 }
8326 }
8327
8328 /**
Chet Haase21cd1382010-09-01 17:42:29 -07008329 * Interface definition for a callback to be invoked when the layout bounds of a view
8330 * changes due to layout processing.
8331 */
8332 public interface OnLayoutChangeListener {
8333 /**
8334 * Called when the focus state of a view has changed.
8335 *
8336 * @param v The view whose state has changed.
8337 * @param left The new value of the view's left property.
8338 * @param top The new value of the view's top property.
8339 * @param right The new value of the view's right property.
8340 * @param bottom The new value of the view's bottom property.
8341 * @param oldLeft The previous value of the view's left property.
8342 * @param oldTop The previous value of the view's top property.
8343 * @param oldRight The previous value of the view's right property.
8344 * @param oldBottom The previous value of the view's bottom property.
8345 */
8346 void onLayoutChange(View v, int left, int top, int right, int bottom,
8347 int oldLeft, int oldTop, int oldRight, int oldBottom);
8348 }
8349
8350 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008351 * This is called during layout when the size of this view has changed. If
8352 * you were just added to the view hierarchy, you're called with the old
8353 * values of 0.
8354 *
8355 * @param w Current width of this view.
8356 * @param h Current height of this view.
8357 * @param oldw Old width of this view.
8358 * @param oldh Old height of this view.
8359 */
8360 protected void onSizeChanged(int w, int h, int oldw, int oldh) {
8361 }
8362
8363 /**
8364 * Called by draw to draw the child views. This may be overridden
8365 * by derived classes to gain control just before its children are drawn
8366 * (but after its own view has been drawn).
8367 * @param canvas the canvas on which to draw the view
8368 */
8369 protected void dispatchDraw(Canvas canvas) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07008370
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008371 }
8372
8373 /**
8374 * Gets the parent of this view. Note that the parent is a
8375 * ViewParent and not necessarily a View.
8376 *
8377 * @return Parent of this view.
8378 */
8379 public final ViewParent getParent() {
8380 return mParent;
8381 }
8382
8383 /**
Chet Haasecca2c982011-05-20 14:34:18 -07008384 * Set the horizontal scrolled position of your view. This will cause a call to
8385 * {@link #onScrollChanged(int, int, int, int)} and the view will be
8386 * invalidated.
8387 * @param value the x position to scroll to
8388 */
8389 public void setScrollX(int value) {
8390 scrollTo(value, mScrollY);
8391 }
8392
8393 /**
8394 * Set the vertical scrolled position of your view. This will cause a call to
8395 * {@link #onScrollChanged(int, int, int, int)} and the view will be
8396 * invalidated.
8397 * @param value the y position to scroll to
8398 */
8399 public void setScrollY(int value) {
8400 scrollTo(mScrollX, value);
8401 }
8402
8403 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008404 * Return the scrolled left position of this view. This is the left edge of
8405 * the displayed part of your view. You do not need to draw any pixels
8406 * farther left, since those are outside of the frame of your view on
8407 * screen.
8408 *
8409 * @return The left edge of the displayed part of your view, in pixels.
8410 */
8411 public final int getScrollX() {
8412 return mScrollX;
8413 }
8414
8415 /**
8416 * Return the scrolled top position of this view. This is the top edge of
8417 * the displayed part of your view. You do not need to draw any pixels above
8418 * it, since those are outside of the frame of your view on screen.
8419 *
8420 * @return The top edge of the displayed part of your view, in pixels.
8421 */
8422 public final int getScrollY() {
8423 return mScrollY;
8424 }
8425
8426 /**
8427 * Return the width of the your view.
8428 *
8429 * @return The width of your view, in pixels.
8430 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07008431 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008432 public final int getWidth() {
8433 return mRight - mLeft;
8434 }
8435
8436 /**
8437 * Return the height of your view.
8438 *
8439 * @return The height of your view, in pixels.
8440 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07008441 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008442 public final int getHeight() {
8443 return mBottom - mTop;
8444 }
8445
8446 /**
8447 * Return the visible drawing bounds of your view. Fills in the output
8448 * rectangle with the values from getScrollX(), getScrollY(),
8449 * getWidth(), and getHeight().
8450 *
8451 * @param outRect The (scrolled) drawing bounds of the view.
8452 */
8453 public void getDrawingRect(Rect outRect) {
8454 outRect.left = mScrollX;
8455 outRect.top = mScrollY;
8456 outRect.right = mScrollX + (mRight - mLeft);
8457 outRect.bottom = mScrollY + (mBottom - mTop);
8458 }
8459
8460 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08008461 * Like {@link #getMeasuredWidthAndState()}, but only returns the
8462 * raw width component (that is the result is masked by
8463 * {@link #MEASURED_SIZE_MASK}).
8464 *
8465 * @return The raw measured width of this view.
8466 */
8467 public final int getMeasuredWidth() {
8468 return mMeasuredWidth & MEASURED_SIZE_MASK;
8469 }
8470
8471 /**
8472 * Return the full width measurement information for this view as computed
Romain Guy5c22a8c2011-05-13 11:48:45 -07008473 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask
Dianne Hackborn189ee182010-12-02 21:48:53 -08008474 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008475 * This should be used during measurement and layout calculations only. Use
8476 * {@link #getWidth()} to see how wide a view is after layout.
8477 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08008478 * @return The measured width of this view as a bit mask.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008479 */
Dianne Hackborn189ee182010-12-02 21:48:53 -08008480 public final int getMeasuredWidthAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008481 return mMeasuredWidth;
8482 }
8483
8484 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08008485 * Like {@link #getMeasuredHeightAndState()}, but only returns the
8486 * raw width component (that is the result is masked by
8487 * {@link #MEASURED_SIZE_MASK}).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008488 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08008489 * @return The raw measured height of this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008490 */
8491 public final int getMeasuredHeight() {
Dianne Hackborn189ee182010-12-02 21:48:53 -08008492 return mMeasuredHeight & MEASURED_SIZE_MASK;
8493 }
8494
8495 /**
8496 * Return the full height measurement information for this view as computed
Romain Guy5c22a8c2011-05-13 11:48:45 -07008497 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask
Dianne Hackborn189ee182010-12-02 21:48:53 -08008498 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
8499 * This should be used during measurement and layout calculations only. Use
8500 * {@link #getHeight()} to see how wide a view is after layout.
8501 *
8502 * @return The measured width of this view as a bit mask.
8503 */
8504 public final int getMeasuredHeightAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008505 return mMeasuredHeight;
8506 }
8507
8508 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08008509 * Return only the state bits of {@link #getMeasuredWidthAndState()}
8510 * and {@link #getMeasuredHeightAndState()}, combined into one integer.
8511 * The width component is in the regular bits {@link #MEASURED_STATE_MASK}
8512 * and the height component is at the shifted bits
8513 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}.
8514 */
8515 public final int getMeasuredState() {
8516 return (mMeasuredWidth&MEASURED_STATE_MASK)
8517 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT)
8518 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT));
8519 }
8520
8521 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07008522 * The transform matrix of this view, which is calculated based on the current
8523 * roation, scale, and pivot properties.
8524 *
8525 * @see #getRotation()
8526 * @see #getScaleX()
8527 * @see #getScaleY()
8528 * @see #getPivotX()
8529 * @see #getPivotY()
8530 * @return The current transform matrix for the view
8531 */
8532 public Matrix getMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008533 if (mTransformationInfo != null) {
8534 updateMatrix();
8535 return mTransformationInfo.mMatrix;
8536 }
8537 return Matrix.IDENTITY_MATRIX;
Romain Guy33e72ae2010-07-17 12:40:29 -07008538 }
8539
8540 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07008541 * Utility function to determine if the value is far enough away from zero to be
8542 * considered non-zero.
8543 * @param value A floating point value to check for zero-ness
8544 * @return whether the passed-in value is far enough away from zero to be considered non-zero
8545 */
8546 private static boolean nonzero(float value) {
8547 return (value < -NONZERO_EPSILON || value > NONZERO_EPSILON);
8548 }
8549
8550 /**
Jeff Brown86671742010-09-30 20:00:15 -07008551 * Returns true if the transform matrix is the identity matrix.
8552 * Recomputes the matrix if necessary.
Joe Malin32736f02011-01-19 16:14:20 -08008553 *
Romain Guy33e72ae2010-07-17 12:40:29 -07008554 * @return True if the transform matrix is the identity matrix, false otherwise.
8555 */
Jeff Brown86671742010-09-30 20:00:15 -07008556 final boolean hasIdentityMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008557 if (mTransformationInfo != null) {
8558 updateMatrix();
8559 return mTransformationInfo.mMatrixIsIdentity;
8560 }
8561 return true;
8562 }
8563
8564 void ensureTransformationInfo() {
8565 if (mTransformationInfo == null) {
8566 mTransformationInfo = new TransformationInfo();
8567 }
Jeff Brown86671742010-09-30 20:00:15 -07008568 }
8569
8570 /**
8571 * Recomputes the transform matrix if necessary.
8572 */
Romain Guy2fe9a8f2010-10-04 20:17:01 -07008573 private void updateMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008574 final TransformationInfo info = mTransformationInfo;
8575 if (info == null) {
8576 return;
8577 }
8578 if (info.mMatrixDirty) {
Chet Haasec3aa3612010-06-17 08:50:37 -07008579 // transform-related properties have changed since the last time someone
8580 // asked for the matrix; recalculate it with the current values
Chet Haasefd2b0022010-08-06 13:08:56 -07008581
8582 // Figure out if we need to update the pivot point
Dianne Hackborn4702a852012-08-17 15:18:29 -07008583 if ((mPrivateFlags & PFLAG_PIVOT_EXPLICITLY_SET) == 0) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008584 if ((mRight - mLeft) != info.mPrevWidth || (mBottom - mTop) != info.mPrevHeight) {
8585 info.mPrevWidth = mRight - mLeft;
8586 info.mPrevHeight = mBottom - mTop;
8587 info.mPivotX = info.mPrevWidth / 2f;
8588 info.mPivotY = info.mPrevHeight / 2f;
Chet Haasefd2b0022010-08-06 13:08:56 -07008589 }
8590 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008591 info.mMatrix.reset();
8592 if (!nonzero(info.mRotationX) && !nonzero(info.mRotationY)) {
8593 info.mMatrix.setTranslate(info.mTranslationX, info.mTranslationY);
8594 info.mMatrix.preRotate(info.mRotation, info.mPivotX, info.mPivotY);
8595 info.mMatrix.preScale(info.mScaleX, info.mScaleY, info.mPivotX, info.mPivotY);
Chet Haase897247b2010-09-09 14:54:47 -07008596 } else {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008597 if (info.mCamera == null) {
8598 info.mCamera = new Camera();
8599 info.matrix3D = new Matrix();
Chet Haasefd2b0022010-08-06 13:08:56 -07008600 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008601 info.mCamera.save();
8602 info.mMatrix.preScale(info.mScaleX, info.mScaleY, info.mPivotX, info.mPivotY);
8603 info.mCamera.rotate(info.mRotationX, info.mRotationY, -info.mRotation);
8604 info.mCamera.getMatrix(info.matrix3D);
8605 info.matrix3D.preTranslate(-info.mPivotX, -info.mPivotY);
8606 info.matrix3D.postTranslate(info.mPivotX + info.mTranslationX,
8607 info.mPivotY + info.mTranslationY);
8608 info.mMatrix.postConcat(info.matrix3D);
8609 info.mCamera.restore();
Chet Haasefd2b0022010-08-06 13:08:56 -07008610 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008611 info.mMatrixDirty = false;
8612 info.mMatrixIsIdentity = info.mMatrix.isIdentity();
8613 info.mInverseMatrixDirty = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07008614 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008615 }
8616
8617 /**
Tobias Duboisdefdb1e2010-12-15 11:35:30 +01008618 * When searching for a view to focus this rectangle is used when considering if this view is
8619 * a good candidate for receiving focus.
8620 *
8621 * By default, the rectangle is the {@link #getDrawingRect}) of the view.
8622 *
8623 * @param r The rectangle to fill in, in this view's coordinates.
8624 */
8625 public void getFocusRect(Rect r) {
8626 getDrawingRect(r);
8627 }
8628
8629 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07008630 * Utility method to retrieve the inverse of the current mMatrix property.
8631 * We cache the matrix to avoid recalculating it when transform properties
8632 * have not changed.
8633 *
8634 * @return The inverse of the current matrix of this view.
8635 */
Jeff Brown86671742010-09-30 20:00:15 -07008636 final Matrix getInverseMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008637 final TransformationInfo info = mTransformationInfo;
8638 if (info != null) {
8639 updateMatrix();
8640 if (info.mInverseMatrixDirty) {
8641 if (info.mInverseMatrix == null) {
8642 info.mInverseMatrix = new Matrix();
8643 }
8644 info.mMatrix.invert(info.mInverseMatrix);
8645 info.mInverseMatrixDirty = false;
Chet Haasec3aa3612010-06-17 08:50:37 -07008646 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008647 return info.mInverseMatrix;
Chet Haasec3aa3612010-06-17 08:50:37 -07008648 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008649 return Matrix.IDENTITY_MATRIX;
Chet Haasec3aa3612010-06-17 08:50:37 -07008650 }
8651
8652 /**
Chet Haasea1cff502012-02-21 13:43:44 -08008653 * Gets the distance along the Z axis from the camera to this view.
8654 *
8655 * @see #setCameraDistance(float)
8656 *
8657 * @return The distance along the Z axis.
8658 */
8659 public float getCameraDistance() {
8660 ensureTransformationInfo();
8661 final float dpi = mResources.getDisplayMetrics().densityDpi;
8662 final TransformationInfo info = mTransformationInfo;
8663 if (info.mCamera == null) {
8664 info.mCamera = new Camera();
8665 info.matrix3D = new Matrix();
8666 }
8667 return -(info.mCamera.getLocationZ() * dpi);
8668 }
8669
8670 /**
Romain Guya5364ee2011-02-24 14:46:04 -08008671 * <p>Sets the distance along the Z axis (orthogonal to the X/Y plane on which
8672 * views are drawn) from the camera to this view. The camera's distance
8673 * affects 3D transformations, for instance rotations around the X and Y
8674 * axis. If the rotationX or rotationY properties are changed and this view is
Philip Milne6c8ea062012-04-03 17:38:43 -07008675 * large (more than half the size of the screen), it is recommended to always
Romain Guya5364ee2011-02-24 14:46:04 -08008676 * use a camera distance that's greater than the height (X axis rotation) or
8677 * the width (Y axis rotation) of this view.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008678 *
Romain Guya5364ee2011-02-24 14:46:04 -08008679 * <p>The distance of the camera from the view plane can have an affect on the
8680 * perspective distortion of the view when it is rotated around the x or y axis.
8681 * For example, a large distance will result in a large viewing angle, and there
8682 * will not be much perspective distortion of the view as it rotates. A short
Philip Milne6c8ea062012-04-03 17:38:43 -07008683 * distance may cause much more perspective distortion upon rotation, and can
Romain Guya5364ee2011-02-24 14:46:04 -08008684 * also result in some drawing artifacts if the rotated view ends up partially
8685 * behind the camera (which is why the recommendation is to use a distance at
8686 * least as far as the size of the view, if the view is to be rotated.)</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008687 *
Romain Guya5364ee2011-02-24 14:46:04 -08008688 * <p>The distance is expressed in "depth pixels." The default distance depends
8689 * on the screen density. For instance, on a medium density display, the
8690 * default distance is 1280. On a high density display, the default distance
8691 * is 1920.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008692 *
Romain Guya5364ee2011-02-24 14:46:04 -08008693 * <p>If you want to specify a distance that leads to visually consistent
8694 * results across various densities, use the following formula:</p>
8695 * <pre>
8696 * float scale = context.getResources().getDisplayMetrics().density;
8697 * view.setCameraDistance(distance * scale);
8698 * </pre>
Philip Milne6c8ea062012-04-03 17:38:43 -07008699 *
Romain Guya5364ee2011-02-24 14:46:04 -08008700 * <p>The density scale factor of a high density display is 1.5,
8701 * and 1920 = 1280 * 1.5.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008702 *
Romain Guya5364ee2011-02-24 14:46:04 -08008703 * @param distance The distance in "depth pixels", if negative the opposite
8704 * value is used
Philip Milne6c8ea062012-04-03 17:38:43 -07008705 *
8706 * @see #setRotationX(float)
8707 * @see #setRotationY(float)
Romain Guya5364ee2011-02-24 14:46:04 -08008708 */
8709 public void setCameraDistance(float distance) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008710 invalidateViewProperty(true, false);
Romain Guya5364ee2011-02-24 14:46:04 -08008711
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008712 ensureTransformationInfo();
Romain Guya5364ee2011-02-24 14:46:04 -08008713 final float dpi = mResources.getDisplayMetrics().densityDpi;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008714 final TransformationInfo info = mTransformationInfo;
8715 if (info.mCamera == null) {
8716 info.mCamera = new Camera();
8717 info.matrix3D = new Matrix();
Romain Guya5364ee2011-02-24 14:46:04 -08008718 }
8719
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008720 info.mCamera.setLocation(0.0f, 0.0f, -Math.abs(distance) / dpi);
8721 info.mMatrixDirty = true;
Romain Guya5364ee2011-02-24 14:46:04 -08008722
Chet Haase9d1992d2012-03-13 11:03:25 -07008723 invalidateViewProperty(false, false);
Chet Haase1271e2c2012-04-20 09:54:27 -07008724 if (mDisplayList != null) {
Chet Haaseb85967b2012-03-26 14:37:51 -07008725 mDisplayList.setCameraDistance(-Math.abs(distance) / dpi);
Chet Haasea1cff502012-02-21 13:43:44 -08008726 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07008727 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) {
Chet Haase1a3ab172012-05-11 08:41:20 -07008728 // View was rejected last time it was drawn by its parent; this may have changed
8729 invalidateParentIfNeeded();
8730 }
Romain Guya5364ee2011-02-24 14:46:04 -08008731 }
8732
8733 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07008734 * The degrees that the view is rotated around the pivot point.
8735 *
Philip Milne6c8ea062012-04-03 17:38:43 -07008736 * @see #setRotation(float)
Chet Haasec3aa3612010-06-17 08:50:37 -07008737 * @see #getPivotX()
8738 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008739 *
Chet Haasec3aa3612010-06-17 08:50:37 -07008740 * @return The degrees of rotation.
8741 */
Chet Haasea5531132012-02-02 13:41:44 -08008742 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008743 public float getRotation() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008744 return mTransformationInfo != null ? mTransformationInfo.mRotation : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07008745 }
8746
8747 /**
Chet Haase897247b2010-09-09 14:54:47 -07008748 * Sets the degrees that the view is rotated around the pivot point. Increasing values
8749 * result in clockwise rotation.
Chet Haasec3aa3612010-06-17 08:50:37 -07008750 *
8751 * @param rotation The degrees of rotation.
Philip Milne6c8ea062012-04-03 17:38:43 -07008752 *
8753 * @see #getRotation()
Chet Haasec3aa3612010-06-17 08:50:37 -07008754 * @see #getPivotX()
8755 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008756 * @see #setRotationX(float)
8757 * @see #setRotationY(float)
Chet Haase73066682010-11-29 15:55:32 -08008758 *
8759 * @attr ref android.R.styleable#View_rotation
Chet Haasec3aa3612010-06-17 08:50:37 -07008760 */
8761 public void setRotation(float rotation) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008762 ensureTransformationInfo();
8763 final TransformationInfo info = mTransformationInfo;
8764 if (info.mRotation != rotation) {
Chet Haasec3aa3612010-06-17 08:50:37 -07008765 // Double-invalidation is necessary to capture view's old and new areas
Chet Haase9d1992d2012-03-13 11:03:25 -07008766 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008767 info.mRotation = rotation;
8768 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008769 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008770 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008771 mDisplayList.setRotation(rotation);
8772 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07008773 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) {
Chet Haase1a3ab172012-05-11 08:41:20 -07008774 // View was rejected last time it was drawn by its parent; this may have changed
8775 invalidateParentIfNeeded();
8776 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008777 }
8778 }
8779
8780 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07008781 * The degrees that the view is rotated around the vertical axis through the pivot point.
8782 *
8783 * @see #getPivotX()
8784 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008785 * @see #setRotationY(float)
8786 *
Chet Haasefd2b0022010-08-06 13:08:56 -07008787 * @return The degrees of Y rotation.
8788 */
Chet Haasea5531132012-02-02 13:41:44 -08008789 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasefd2b0022010-08-06 13:08:56 -07008790 public float getRotationY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008791 return mTransformationInfo != null ? mTransformationInfo.mRotationY : 0;
Chet Haasefd2b0022010-08-06 13:08:56 -07008792 }
8793
8794 /**
Chet Haase897247b2010-09-09 14:54:47 -07008795 * Sets the degrees that the view is rotated around the vertical axis through the pivot point.
8796 * Increasing values result in counter-clockwise rotation from the viewpoint of looking
8797 * down the y axis.
Philip Milne6c8ea062012-04-03 17:38:43 -07008798 *
Romain Guya5364ee2011-02-24 14:46:04 -08008799 * When rotating large views, it is recommended to adjust the camera distance
8800 * accordingly. Refer to {@link #setCameraDistance(float)} for more information.
Chet Haasefd2b0022010-08-06 13:08:56 -07008801 *
8802 * @param rotationY The degrees of Y rotation.
Philip Milne6c8ea062012-04-03 17:38:43 -07008803 *
8804 * @see #getRotationY()
Chet Haasefd2b0022010-08-06 13:08:56 -07008805 * @see #getPivotX()
8806 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08008807 * @see #setRotation(float)
Philip Milne6c8ea062012-04-03 17:38:43 -07008808 * @see #setRotationX(float)
8809 * @see #setCameraDistance(float)
Chet Haase73066682010-11-29 15:55:32 -08008810 *
8811 * @attr ref android.R.styleable#View_rotationY
Chet Haasefd2b0022010-08-06 13:08:56 -07008812 */
8813 public void setRotationY(float rotationY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008814 ensureTransformationInfo();
8815 final TransformationInfo info = mTransformationInfo;
8816 if (info.mRotationY != rotationY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008817 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008818 info.mRotationY = rotationY;
8819 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008820 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008821 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008822 mDisplayList.setRotationY(rotationY);
8823 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07008824 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) {
Chet Haase1a3ab172012-05-11 08:41:20 -07008825 // View was rejected last time it was drawn by its parent; this may have changed
8826 invalidateParentIfNeeded();
8827 }
Chet Haasefd2b0022010-08-06 13:08:56 -07008828 }
8829 }
8830
8831 /**
8832 * The degrees that the view is rotated around the horizontal axis through the pivot point.
8833 *
8834 * @see #getPivotX()
8835 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008836 * @see #setRotationX(float)
8837 *
Chet Haasefd2b0022010-08-06 13:08:56 -07008838 * @return The degrees of X rotation.
8839 */
Chet Haasea5531132012-02-02 13:41:44 -08008840 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasefd2b0022010-08-06 13:08:56 -07008841 public float getRotationX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008842 return mTransformationInfo != null ? mTransformationInfo.mRotationX : 0;
Chet Haasefd2b0022010-08-06 13:08:56 -07008843 }
8844
8845 /**
Chet Haase897247b2010-09-09 14:54:47 -07008846 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point.
8847 * Increasing values result in clockwise rotation from the viewpoint of looking down the
8848 * x axis.
Philip Milne6c8ea062012-04-03 17:38:43 -07008849 *
Romain Guya5364ee2011-02-24 14:46:04 -08008850 * When rotating large views, it is recommended to adjust the camera distance
8851 * accordingly. Refer to {@link #setCameraDistance(float)} for more information.
Chet Haasefd2b0022010-08-06 13:08:56 -07008852 *
8853 * @param rotationX The degrees of X rotation.
Philip Milne6c8ea062012-04-03 17:38:43 -07008854 *
8855 * @see #getRotationX()
Chet Haasefd2b0022010-08-06 13:08:56 -07008856 * @see #getPivotX()
8857 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08008858 * @see #setRotation(float)
Philip Milne6c8ea062012-04-03 17:38:43 -07008859 * @see #setRotationY(float)
8860 * @see #setCameraDistance(float)
Chet Haase73066682010-11-29 15:55:32 -08008861 *
8862 * @attr ref android.R.styleable#View_rotationX
Chet Haasefd2b0022010-08-06 13:08:56 -07008863 */
8864 public void setRotationX(float rotationX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008865 ensureTransformationInfo();
8866 final TransformationInfo info = mTransformationInfo;
8867 if (info.mRotationX != rotationX) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008868 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008869 info.mRotationX = rotationX;
8870 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008871 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008872 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008873 mDisplayList.setRotationX(rotationX);
8874 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07008875 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) {
Chet Haase1a3ab172012-05-11 08:41:20 -07008876 // View was rejected last time it was drawn by its parent; this may have changed
8877 invalidateParentIfNeeded();
8878 }
Chet Haasefd2b0022010-08-06 13:08:56 -07008879 }
8880 }
8881
8882 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07008883 * The amount that the view is scaled in x around the pivot point, as a proportion of
8884 * the view's unscaled width. A value of 1, the default, means that no scaling is applied.
8885 *
Joe Onorato93162322010-09-16 15:42:01 -04008886 * <p>By default, this is 1.0f.
8887 *
Chet Haasec3aa3612010-06-17 08:50:37 -07008888 * @see #getPivotX()
8889 * @see #getPivotY()
8890 * @return The scaling factor.
8891 */
Chet Haasea5531132012-02-02 13:41:44 -08008892 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008893 public float getScaleX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008894 return mTransformationInfo != null ? mTransformationInfo.mScaleX : 1;
Chet Haasec3aa3612010-06-17 08:50:37 -07008895 }
8896
8897 /**
8898 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of
8899 * the view's unscaled width. A value of 1 means that no scaling is applied.
8900 *
8901 * @param scaleX The scaling factor.
8902 * @see #getPivotX()
8903 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008904 *
8905 * @attr ref android.R.styleable#View_scaleX
Chet Haasec3aa3612010-06-17 08:50:37 -07008906 */
8907 public void setScaleX(float scaleX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008908 ensureTransformationInfo();
8909 final TransformationInfo info = mTransformationInfo;
8910 if (info.mScaleX != scaleX) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008911 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008912 info.mScaleX = scaleX;
8913 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008914 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008915 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008916 mDisplayList.setScaleX(scaleX);
8917 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07008918 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) {
Chet Haase1a3ab172012-05-11 08:41:20 -07008919 // View was rejected last time it was drawn by its parent; this may have changed
8920 invalidateParentIfNeeded();
8921 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008922 }
8923 }
8924
8925 /**
8926 * The amount that the view is scaled in y around the pivot point, as a proportion of
8927 * the view's unscaled height. A value of 1, the default, means that no scaling is applied.
8928 *
Joe Onorato93162322010-09-16 15:42:01 -04008929 * <p>By default, this is 1.0f.
8930 *
Chet Haasec3aa3612010-06-17 08:50:37 -07008931 * @see #getPivotX()
8932 * @see #getPivotY()
8933 * @return The scaling factor.
8934 */
Chet Haasea5531132012-02-02 13:41:44 -08008935 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008936 public float getScaleY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008937 return mTransformationInfo != null ? mTransformationInfo.mScaleY : 1;
Chet Haasec3aa3612010-06-17 08:50:37 -07008938 }
8939
8940 /**
8941 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of
8942 * the view's unscaled width. A value of 1 means that no scaling is applied.
8943 *
8944 * @param scaleY The scaling factor.
8945 * @see #getPivotX()
8946 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008947 *
8948 * @attr ref android.R.styleable#View_scaleY
Chet Haasec3aa3612010-06-17 08:50:37 -07008949 */
8950 public void setScaleY(float scaleY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008951 ensureTransformationInfo();
8952 final TransformationInfo info = mTransformationInfo;
8953 if (info.mScaleY != scaleY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008954 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008955 info.mScaleY = scaleY;
8956 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008957 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008958 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008959 mDisplayList.setScaleY(scaleY);
8960 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07008961 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) {
Chet Haase1a3ab172012-05-11 08:41:20 -07008962 // View was rejected last time it was drawn by its parent; this may have changed
8963 invalidateParentIfNeeded();
8964 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008965 }
8966 }
8967
8968 /**
8969 * The x location of the point around which the view is {@link #setRotation(float) rotated}
8970 * and {@link #setScaleX(float) scaled}.
8971 *
8972 * @see #getRotation()
8973 * @see #getScaleX()
8974 * @see #getScaleY()
8975 * @see #getPivotY()
8976 * @return The x location of the pivot point.
Philip Milne6c8ea062012-04-03 17:38:43 -07008977 *
8978 * @attr ref android.R.styleable#View_transformPivotX
Chet Haasec3aa3612010-06-17 08:50:37 -07008979 */
Chet Haasea5531132012-02-02 13:41:44 -08008980 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008981 public float getPivotX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008982 return mTransformationInfo != null ? mTransformationInfo.mPivotX : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07008983 }
8984
8985 /**
8986 * Sets the x location of the point around which the view is
8987 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}.
Chet Haasefd2b0022010-08-06 13:08:56 -07008988 * By default, the pivot point is centered on the object.
8989 * Setting this property disables this behavior and causes the view to use only the
8990 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07008991 *
8992 * @param pivotX The x location of the pivot point.
8993 * @see #getRotation()
8994 * @see #getScaleX()
8995 * @see #getScaleY()
8996 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008997 *
8998 * @attr ref android.R.styleable#View_transformPivotX
Chet Haasec3aa3612010-06-17 08:50:37 -07008999 */
9000 public void setPivotX(float pivotX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009001 ensureTransformationInfo();
Dianne Hackborn4702a852012-08-17 15:18:29 -07009002 mPrivateFlags |= PFLAG_PIVOT_EXPLICITLY_SET;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009003 final TransformationInfo info = mTransformationInfo;
9004 if (info.mPivotX != pivotX) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009005 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009006 info.mPivotX = pivotX;
9007 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07009008 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07009009 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009010 mDisplayList.setPivotX(pivotX);
9011 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07009012 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) {
Chet Haase1a3ab172012-05-11 08:41:20 -07009013 // View was rejected last time it was drawn by its parent; this may have changed
9014 invalidateParentIfNeeded();
9015 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009016 }
9017 }
9018
9019 /**
9020 * The y location of the point around which the view is {@link #setRotation(float) rotated}
9021 * and {@link #setScaleY(float) scaled}.
9022 *
9023 * @see #getRotation()
9024 * @see #getScaleX()
9025 * @see #getScaleY()
9026 * @see #getPivotY()
9027 * @return The y location of the pivot point.
Philip Milne6c8ea062012-04-03 17:38:43 -07009028 *
9029 * @attr ref android.R.styleable#View_transformPivotY
Chet Haasec3aa3612010-06-17 08:50:37 -07009030 */
Chet Haasea5531132012-02-02 13:41:44 -08009031 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07009032 public float getPivotY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009033 return mTransformationInfo != null ? mTransformationInfo.mPivotY : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07009034 }
9035
9036 /**
9037 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated}
Chet Haasefd2b0022010-08-06 13:08:56 -07009038 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object.
9039 * Setting this property disables this behavior and causes the view to use only the
9040 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07009041 *
9042 * @param pivotY The y location of the pivot point.
9043 * @see #getRotation()
9044 * @see #getScaleX()
9045 * @see #getScaleY()
9046 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08009047 *
9048 * @attr ref android.R.styleable#View_transformPivotY
Chet Haasec3aa3612010-06-17 08:50:37 -07009049 */
9050 public void setPivotY(float pivotY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009051 ensureTransformationInfo();
Dianne Hackborn4702a852012-08-17 15:18:29 -07009052 mPrivateFlags |= PFLAG_PIVOT_EXPLICITLY_SET;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009053 final TransformationInfo info = mTransformationInfo;
9054 if (info.mPivotY != pivotY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009055 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009056 info.mPivotY = pivotY;
9057 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07009058 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07009059 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009060 mDisplayList.setPivotY(pivotY);
9061 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07009062 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) {
Chet Haase1a3ab172012-05-11 08:41:20 -07009063 // View was rejected last time it was drawn by its parent; this may have changed
9064 invalidateParentIfNeeded();
9065 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009066 }
9067 }
9068
9069 /**
9070 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is
9071 * completely transparent and 1 means the view is completely opaque.
9072 *
Joe Onorato93162322010-09-16 15:42:01 -04009073 * <p>By default this is 1.0f.
Chet Haasec3aa3612010-06-17 08:50:37 -07009074 * @return The opacity of the view.
9075 */
Chet Haasea5531132012-02-02 13:41:44 -08009076 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07009077 public float getAlpha() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009078 return mTransformationInfo != null ? mTransformationInfo.mAlpha : 1;
Chet Haasec3aa3612010-06-17 08:50:37 -07009079 }
9080
9081 /**
Chet Haasedb8c9a62012-03-21 18:54:18 -07009082 * Returns whether this View has content which overlaps. This function, intended to be
9083 * overridden by specific View types, is an optimization when alpha is set on a view. If
9084 * rendering overlaps in a view with alpha < 1, that view is drawn to an offscreen buffer
9085 * and then composited it into place, which can be expensive. If the view has no overlapping
9086 * rendering, the view can draw each primitive with the appropriate alpha value directly.
9087 * An example of overlapping rendering is a TextView with a background image, such as a
9088 * Button. An example of non-overlapping rendering is a TextView with no background, or
9089 * an ImageView with only the foreground image. The default implementation returns true;
9090 * subclasses should override if they have cases which can be optimized.
9091 *
9092 * @return true if the content in this view might overlap, false otherwise.
9093 */
9094 public boolean hasOverlappingRendering() {
9095 return true;
9096 }
9097
9098 /**
Romain Guy171c5922011-01-06 10:04:23 -08009099 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is
9100 * completely transparent and 1 means the view is completely opaque.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009101 *
Romain Guy171c5922011-01-06 10:04:23 -08009102 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is
9103 * responsible for applying the opacity itself. Otherwise, calling this method is
9104 * equivalent to calling {@link #setLayerType(int, android.graphics.Paint)} and
Joe Malin32736f02011-01-19 16:14:20 -08009105 * setting a hardware layer.</p>
Chet Haasec3aa3612010-06-17 08:50:37 -07009106 *
Chet Haasea5531132012-02-02 13:41:44 -08009107 * <p>Note that setting alpha to a translucent value (0 < alpha < 1) may have
9108 * performance implications. It is generally best to use the alpha property sparingly and
9109 * transiently, as in the case of fading animations.</p>
9110 *
Chet Haasec3aa3612010-06-17 08:50:37 -07009111 * @param alpha The opacity of the view.
Chet Haase73066682010-11-29 15:55:32 -08009112 *
Joe Malin32736f02011-01-19 16:14:20 -08009113 * @see #setLayerType(int, android.graphics.Paint)
9114 *
Chet Haase73066682010-11-29 15:55:32 -08009115 * @attr ref android.R.styleable#View_alpha
Chet Haasec3aa3612010-06-17 08:50:37 -07009116 */
9117 public void setAlpha(float alpha) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009118 ensureTransformationInfo();
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009119 if (mTransformationInfo.mAlpha != alpha) {
9120 mTransformationInfo.mAlpha = alpha;
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009121 if (onSetAlpha((int) (alpha * 255))) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07009122 mPrivateFlags |= PFLAG_ALPHA_SET;
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009123 // subclass is handling alpha - don't optimize rendering cache invalidation
Chet Haase9d1992d2012-03-13 11:03:25 -07009124 invalidateParentCaches();
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009125 invalidate(true);
9126 } else {
Dianne Hackborn4702a852012-08-17 15:18:29 -07009127 mPrivateFlags &= ~PFLAG_ALPHA_SET;
Chet Haase9d1992d2012-03-13 11:03:25 -07009128 invalidateViewProperty(true, false);
Chet Haase1271e2c2012-04-20 09:54:27 -07009129 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009130 mDisplayList.setAlpha(alpha);
9131 }
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009132 }
Chet Haaseed032702010-10-01 14:05:54 -07009133 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009134 }
9135
9136 /**
Chet Haasea00f3862011-02-22 06:34:40 -08009137 * Faster version of setAlpha() which performs the same steps except there are
9138 * no calls to invalidate(). The caller of this function should perform proper invalidation
9139 * on the parent and this object. The return value indicates whether the subclass handles
9140 * alpha (the return value for onSetAlpha()).
9141 *
9142 * @param alpha The new value for the alpha property
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009143 * @return true if the View subclass handles alpha (the return value for onSetAlpha()) and
9144 * the new value for the alpha property is different from the old value
Chet Haasea00f3862011-02-22 06:34:40 -08009145 */
9146 boolean setAlphaNoInvalidation(float alpha) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009147 ensureTransformationInfo();
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009148 if (mTransformationInfo.mAlpha != alpha) {
9149 mTransformationInfo.mAlpha = alpha;
9150 boolean subclassHandlesAlpha = onSetAlpha((int) (alpha * 255));
9151 if (subclassHandlesAlpha) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07009152 mPrivateFlags |= PFLAG_ALPHA_SET;
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009153 return true;
9154 } else {
Dianne Hackborn4702a852012-08-17 15:18:29 -07009155 mPrivateFlags &= ~PFLAG_ALPHA_SET;
Chet Haase1271e2c2012-04-20 09:54:27 -07009156 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009157 mDisplayList.setAlpha(alpha);
9158 }
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009159 }
Chet Haasea00f3862011-02-22 06:34:40 -08009160 }
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009161 return false;
Chet Haasea00f3862011-02-22 06:34:40 -08009162 }
9163
9164 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009165 * Top position of this view relative to its parent.
9166 *
9167 * @return The top of this view, in pixels.
9168 */
9169 @ViewDebug.CapturedViewProperty
9170 public final int getTop() {
9171 return mTop;
9172 }
9173
9174 /**
Chet Haase21cd1382010-09-01 17:42:29 -07009175 * Sets the top position of this view relative to its parent. This method is meant to be called
9176 * by the layout system and should not generally be called otherwise, because the property
9177 * may be changed at any time by the layout.
9178 *
9179 * @param top The top of this view, in pixels.
9180 */
9181 public final void setTop(int top) {
9182 if (top != mTop) {
Jeff Brown86671742010-09-30 20:00:15 -07009183 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009184 final boolean matrixIsIdentity = mTransformationInfo == null
9185 || mTransformationInfo.mMatrixIsIdentity;
9186 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08009187 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07009188 int minTop;
9189 int yLoc;
9190 if (top < mTop) {
9191 minTop = top;
9192 yLoc = top - mTop;
9193 } else {
9194 minTop = mTop;
9195 yLoc = 0;
9196 }
Chet Haasee9140a72011-02-16 16:23:29 -08009197 invalidate(0, yLoc, mRight - mLeft, mBottom - minTop);
Chet Haase21cd1382010-09-01 17:42:29 -07009198 }
9199 } else {
9200 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009201 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009202 }
9203
Chet Haaseed032702010-10-01 14:05:54 -07009204 int width = mRight - mLeft;
9205 int oldHeight = mBottom - mTop;
9206
Chet Haase21cd1382010-09-01 17:42:29 -07009207 mTop = top;
Chet Haase1271e2c2012-04-20 09:54:27 -07009208 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009209 mDisplayList.setTop(mTop);
9210 }
Chet Haase21cd1382010-09-01 17:42:29 -07009211
Chet Haaseed032702010-10-01 14:05:54 -07009212 onSizeChanged(width, mBottom - mTop, width, oldHeight);
9213
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009214 if (!matrixIsIdentity) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07009215 if ((mPrivateFlags & PFLAG_PIVOT_EXPLICITLY_SET) == 0) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009216 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009217 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009218 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07009219 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009220 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009221 }
Chet Haase55dbb652010-12-21 20:15:08 -08009222 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009223 invalidateParentIfNeeded();
Dianne Hackborn4702a852012-08-17 15:18:29 -07009224 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) {
Chet Haase1a3ab172012-05-11 08:41:20 -07009225 // View was rejected last time it was drawn by its parent; this may have changed
9226 invalidateParentIfNeeded();
9227 }
Chet Haase21cd1382010-09-01 17:42:29 -07009228 }
9229 }
9230
9231 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009232 * Bottom position of this view relative to its parent.
9233 *
9234 * @return The bottom of this view, in pixels.
9235 */
9236 @ViewDebug.CapturedViewProperty
9237 public final int getBottom() {
9238 return mBottom;
9239 }
9240
9241 /**
Michael Jurkadab559a2011-01-04 20:31:51 -08009242 * True if this view has changed since the last time being drawn.
9243 *
9244 * @return The dirty state of this view.
9245 */
9246 public boolean isDirty() {
Dianne Hackborn4702a852012-08-17 15:18:29 -07009247 return (mPrivateFlags & PFLAG_DIRTY_MASK) != 0;
Michael Jurkadab559a2011-01-04 20:31:51 -08009248 }
9249
9250 /**
Chet Haase21cd1382010-09-01 17:42:29 -07009251 * Sets the bottom position of this view relative to its parent. This method is meant to be
9252 * called by the layout system and should not generally be called otherwise, because the
9253 * property may be changed at any time by the layout.
9254 *
9255 * @param bottom The bottom of this view, in pixels.
9256 */
9257 public final void setBottom(int bottom) {
9258 if (bottom != mBottom) {
Jeff Brown86671742010-09-30 20:00:15 -07009259 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009260 final boolean matrixIsIdentity = mTransformationInfo == null
9261 || mTransformationInfo.mMatrixIsIdentity;
9262 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08009263 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07009264 int maxBottom;
9265 if (bottom < mBottom) {
9266 maxBottom = mBottom;
9267 } else {
9268 maxBottom = bottom;
9269 }
Chet Haasee9140a72011-02-16 16:23:29 -08009270 invalidate(0, 0, mRight - mLeft, maxBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07009271 }
9272 } else {
9273 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009274 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009275 }
9276
Chet Haaseed032702010-10-01 14:05:54 -07009277 int width = mRight - mLeft;
9278 int oldHeight = mBottom - mTop;
9279
Chet Haase21cd1382010-09-01 17:42:29 -07009280 mBottom = bottom;
Chet Haase1271e2c2012-04-20 09:54:27 -07009281 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009282 mDisplayList.setBottom(mBottom);
9283 }
Chet Haase21cd1382010-09-01 17:42:29 -07009284
Chet Haaseed032702010-10-01 14:05:54 -07009285 onSizeChanged(width, mBottom - mTop, width, oldHeight);
9286
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009287 if (!matrixIsIdentity) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07009288 if ((mPrivateFlags & PFLAG_PIVOT_EXPLICITLY_SET) == 0) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009289 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009290 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009291 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07009292 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009293 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009294 }
Chet Haase55dbb652010-12-21 20:15:08 -08009295 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009296 invalidateParentIfNeeded();
Dianne Hackborn4702a852012-08-17 15:18:29 -07009297 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) {
Chet Haase1a3ab172012-05-11 08:41:20 -07009298 // View was rejected last time it was drawn by its parent; this may have changed
9299 invalidateParentIfNeeded();
9300 }
Chet Haase21cd1382010-09-01 17:42:29 -07009301 }
9302 }
9303
9304 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009305 * Left position of this view relative to its parent.
9306 *
9307 * @return The left edge of this view, in pixels.
9308 */
9309 @ViewDebug.CapturedViewProperty
9310 public final int getLeft() {
9311 return mLeft;
9312 }
9313
9314 /**
Chet Haase21cd1382010-09-01 17:42:29 -07009315 * Sets the left position of this view relative to its parent. This method is meant to be called
9316 * by the layout system and should not generally be called otherwise, because the property
9317 * may be changed at any time by the layout.
9318 *
9319 * @param left The bottom of this view, in pixels.
9320 */
9321 public final void setLeft(int left) {
9322 if (left != mLeft) {
Jeff Brown86671742010-09-30 20:00:15 -07009323 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009324 final boolean matrixIsIdentity = mTransformationInfo == null
9325 || mTransformationInfo.mMatrixIsIdentity;
9326 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08009327 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07009328 int minLeft;
9329 int xLoc;
9330 if (left < mLeft) {
9331 minLeft = left;
9332 xLoc = left - mLeft;
9333 } else {
9334 minLeft = mLeft;
9335 xLoc = 0;
9336 }
Chet Haasee9140a72011-02-16 16:23:29 -08009337 invalidate(xLoc, 0, mRight - minLeft, mBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07009338 }
9339 } else {
9340 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009341 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009342 }
9343
Chet Haaseed032702010-10-01 14:05:54 -07009344 int oldWidth = mRight - mLeft;
9345 int height = mBottom - mTop;
9346
Chet Haase21cd1382010-09-01 17:42:29 -07009347 mLeft = left;
Chet Haase1271e2c2012-04-20 09:54:27 -07009348 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009349 mDisplayList.setLeft(left);
9350 }
Chet Haase21cd1382010-09-01 17:42:29 -07009351
Chet Haaseed032702010-10-01 14:05:54 -07009352 onSizeChanged(mRight - mLeft, height, oldWidth, height);
9353
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009354 if (!matrixIsIdentity) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07009355 if ((mPrivateFlags & PFLAG_PIVOT_EXPLICITLY_SET) == 0) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009356 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009357 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009358 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07009359 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009360 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009361 }
Chet Haase55dbb652010-12-21 20:15:08 -08009362 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009363 invalidateParentIfNeeded();
Dianne Hackborn4702a852012-08-17 15:18:29 -07009364 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) {
Chet Haase1a3ab172012-05-11 08:41:20 -07009365 // View was rejected last time it was drawn by its parent; this may have changed
9366 invalidateParentIfNeeded();
9367 }
Chet Haase21cd1382010-09-01 17:42:29 -07009368 }
9369 }
9370
9371 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009372 * Right position of this view relative to its parent.
9373 *
9374 * @return The right edge of this view, in pixels.
9375 */
9376 @ViewDebug.CapturedViewProperty
9377 public final int getRight() {
9378 return mRight;
9379 }
9380
9381 /**
Chet Haase21cd1382010-09-01 17:42:29 -07009382 * Sets the right position of this view relative to its parent. This method is meant to be called
9383 * by the layout system and should not generally be called otherwise, because the property
9384 * may be changed at any time by the layout.
9385 *
9386 * @param right The bottom of this view, in pixels.
9387 */
9388 public final void setRight(int right) {
9389 if (right != mRight) {
Jeff Brown86671742010-09-30 20:00:15 -07009390 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009391 final boolean matrixIsIdentity = mTransformationInfo == null
9392 || mTransformationInfo.mMatrixIsIdentity;
9393 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08009394 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07009395 int maxRight;
9396 if (right < mRight) {
9397 maxRight = mRight;
9398 } else {
9399 maxRight = right;
9400 }
Chet Haasee9140a72011-02-16 16:23:29 -08009401 invalidate(0, 0, maxRight - mLeft, mBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07009402 }
9403 } else {
9404 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009405 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009406 }
9407
Chet Haaseed032702010-10-01 14:05:54 -07009408 int oldWidth = mRight - mLeft;
9409 int height = mBottom - mTop;
9410
Chet Haase21cd1382010-09-01 17:42:29 -07009411 mRight = right;
Chet Haase1271e2c2012-04-20 09:54:27 -07009412 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009413 mDisplayList.setRight(mRight);
9414 }
Chet Haase21cd1382010-09-01 17:42:29 -07009415
Chet Haaseed032702010-10-01 14:05:54 -07009416 onSizeChanged(mRight - mLeft, height, oldWidth, height);
9417
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009418 if (!matrixIsIdentity) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07009419 if ((mPrivateFlags & PFLAG_PIVOT_EXPLICITLY_SET) == 0) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009420 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009421 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009422 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07009423 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009424 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009425 }
Chet Haase55dbb652010-12-21 20:15:08 -08009426 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009427 invalidateParentIfNeeded();
Dianne Hackborn4702a852012-08-17 15:18:29 -07009428 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) {
Chet Haase1a3ab172012-05-11 08:41:20 -07009429 // View was rejected last time it was drawn by its parent; this may have changed
9430 invalidateParentIfNeeded();
9431 }
Chet Haase21cd1382010-09-01 17:42:29 -07009432 }
9433 }
9434
9435 /**
Chet Haasedf030d22010-07-30 17:22:38 -07009436 * The visual x position of this view, in pixels. This is equivalent to the
9437 * {@link #setTranslationX(float) translationX} property plus the current
Joe Malin32736f02011-01-19 16:14:20 -08009438 * {@link #getLeft() left} property.
Chet Haasec3aa3612010-06-17 08:50:37 -07009439 *
Chet Haasedf030d22010-07-30 17:22:38 -07009440 * @return The visual x position of this view, in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07009441 */
Chet Haasea5531132012-02-02 13:41:44 -08009442 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009443 public float getX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009444 return mLeft + (mTransformationInfo != null ? mTransformationInfo.mTranslationX : 0);
Chet Haasedf030d22010-07-30 17:22:38 -07009445 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009446
Chet Haasedf030d22010-07-30 17:22:38 -07009447 /**
9448 * Sets the visual x position of this view, in pixels. This is equivalent to setting the
9449 * {@link #setTranslationX(float) translationX} property to be the difference between
9450 * the x value passed in and the current {@link #getLeft() left} property.
9451 *
9452 * @param x The visual x position of this view, in pixels.
9453 */
9454 public void setX(float x) {
9455 setTranslationX(x - mLeft);
9456 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009457
Chet Haasedf030d22010-07-30 17:22:38 -07009458 /**
9459 * The visual y position of this view, in pixels. This is equivalent to the
9460 * {@link #setTranslationY(float) translationY} property plus the current
9461 * {@link #getTop() top} property.
9462 *
9463 * @return The visual y position of this view, in pixels.
9464 */
Chet Haasea5531132012-02-02 13:41:44 -08009465 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009466 public float getY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009467 return mTop + (mTransformationInfo != null ? mTransformationInfo.mTranslationY : 0);
Chet Haasedf030d22010-07-30 17:22:38 -07009468 }
9469
9470 /**
9471 * Sets the visual y position of this view, in pixels. This is equivalent to setting the
9472 * {@link #setTranslationY(float) translationY} property to be the difference between
9473 * the y value passed in and the current {@link #getTop() top} property.
9474 *
9475 * @param y The visual y position of this view, in pixels.
9476 */
9477 public void setY(float y) {
9478 setTranslationY(y - mTop);
9479 }
9480
9481
9482 /**
9483 * The horizontal location of this view relative to its {@link #getLeft() left} position.
9484 * This position is post-layout, in addition to wherever the object's
9485 * layout placed it.
9486 *
9487 * @return The horizontal position of this view relative to its left position, in pixels.
9488 */
Chet Haasea5531132012-02-02 13:41:44 -08009489 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009490 public float getTranslationX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009491 return mTransformationInfo != null ? mTransformationInfo.mTranslationX : 0;
Chet Haasedf030d22010-07-30 17:22:38 -07009492 }
9493
9494 /**
9495 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position.
9496 * This effectively positions the object post-layout, in addition to wherever the object's
9497 * layout placed it.
9498 *
9499 * @param translationX The horizontal position of this view relative to its left position,
9500 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08009501 *
9502 * @attr ref android.R.styleable#View_translationX
Chet Haasedf030d22010-07-30 17:22:38 -07009503 */
9504 public void setTranslationX(float translationX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009505 ensureTransformationInfo();
9506 final TransformationInfo info = mTransformationInfo;
9507 if (info.mTranslationX != translationX) {
Chet Haasedf030d22010-07-30 17:22:38 -07009508 // Double-invalidation is necessary to capture view's old and new areas
Chet Haase9d1992d2012-03-13 11:03:25 -07009509 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009510 info.mTranslationX = translationX;
9511 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07009512 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07009513 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009514 mDisplayList.setTranslationX(translationX);
9515 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07009516 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) {
Chet Haase1a3ab172012-05-11 08:41:20 -07009517 // View was rejected last time it was drawn by its parent; this may have changed
9518 invalidateParentIfNeeded();
9519 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009520 }
9521 }
9522
9523 /**
Chet Haasedf030d22010-07-30 17:22:38 -07009524 * The horizontal location of this view relative to its {@link #getTop() top} position.
9525 * This position is post-layout, in addition to wherever the object's
9526 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07009527 *
Chet Haasedf030d22010-07-30 17:22:38 -07009528 * @return The vertical position of this view relative to its top position,
9529 * in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07009530 */
Chet Haasea5531132012-02-02 13:41:44 -08009531 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009532 public float getTranslationY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009533 return mTransformationInfo != null ? mTransformationInfo.mTranslationY : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07009534 }
9535
9536 /**
Chet Haasedf030d22010-07-30 17:22:38 -07009537 * Sets the vertical location of this view relative to its {@link #getTop() top} position.
9538 * This effectively positions the object post-layout, in addition to wherever the object's
9539 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07009540 *
Chet Haasedf030d22010-07-30 17:22:38 -07009541 * @param translationY The vertical position of this view relative to its top position,
9542 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08009543 *
9544 * @attr ref android.R.styleable#View_translationY
Chet Haasec3aa3612010-06-17 08:50:37 -07009545 */
Chet Haasedf030d22010-07-30 17:22:38 -07009546 public void setTranslationY(float translationY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009547 ensureTransformationInfo();
9548 final TransformationInfo info = mTransformationInfo;
9549 if (info.mTranslationY != translationY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009550 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009551 info.mTranslationY = translationY;
9552 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07009553 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07009554 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009555 mDisplayList.setTranslationY(translationY);
9556 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07009557 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) {
Chet Haase1a3ab172012-05-11 08:41:20 -07009558 // View was rejected last time it was drawn by its parent; this may have changed
9559 invalidateParentIfNeeded();
9560 }
Chet Haasedf030d22010-07-30 17:22:38 -07009561 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009562 }
9563
9564 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009565 * Hit rectangle in parent's coordinates
9566 *
9567 * @param outRect The hit rectangle of the view.
9568 */
9569 public void getHitRect(Rect outRect) {
Jeff Brown86671742010-09-30 20:00:15 -07009570 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009571 final TransformationInfo info = mTransformationInfo;
9572 if (info == null || info.mMatrixIsIdentity || mAttachInfo == null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07009573 outRect.set(mLeft, mTop, mRight, mBottom);
9574 } else {
9575 final RectF tmpRect = mAttachInfo.mTmpTransformRect;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009576 tmpRect.set(-info.mPivotX, -info.mPivotY,
9577 getWidth() - info.mPivotX, getHeight() - info.mPivotY);
9578 info.mMatrix.mapRect(tmpRect);
Romain Guy33e72ae2010-07-17 12:40:29 -07009579 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop,
9580 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop);
Chet Haasec3aa3612010-06-17 08:50:37 -07009581 }
9582 }
9583
9584 /**
Jeff Brown20e987b2010-08-23 12:01:02 -07009585 * Determines whether the given point, in local coordinates is inside the view.
9586 */
9587 /*package*/ final boolean pointInView(float localX, float localY) {
9588 return localX >= 0 && localX < (mRight - mLeft)
9589 && localY >= 0 && localY < (mBottom - mTop);
9590 }
9591
9592 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07009593 * Utility method to determine whether the given point, in local coordinates,
9594 * is inside the view, where the area of the view is expanded by the slop factor.
9595 * This method is called while processing touch-move events to determine if the event
9596 * is still within the view.
9597 */
9598 private boolean pointInView(float localX, float localY, float slop) {
Jeff Brown20e987b2010-08-23 12:01:02 -07009599 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) &&
Romain Guy33e72ae2010-07-17 12:40:29 -07009600 localY < ((mBottom - mTop) + slop);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009601 }
9602
9603 /**
9604 * When a view has focus and the user navigates away from it, the next view is searched for
9605 * starting from the rectangle filled in by this method.
9606 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07009607 * By default, the rectange is the {@link #getDrawingRect(android.graphics.Rect)})
9608 * of the view. However, if your view maintains some idea of internal selection,
9609 * such as a cursor, or a selected row or column, you should override this method and
9610 * fill in a more specific rectangle.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009611 *
9612 * @param r The rectangle to fill in, in this view's coordinates.
9613 */
9614 public void getFocusedRect(Rect r) {
9615 getDrawingRect(r);
9616 }
9617
9618 /**
9619 * If some part of this view is not clipped by any of its parents, then
9620 * return that area in r in global (root) coordinates. To convert r to local
Gilles Debunnecea45132011-11-24 02:19:27 +01009621 * coordinates (without taking possible View rotations into account), offset
9622 * it by -globalOffset (e.g. r.offset(-globalOffset.x, -globalOffset.y)).
9623 * If the view is completely clipped or translated out, return false.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009624 *
9625 * @param r If true is returned, r holds the global coordinates of the
9626 * visible portion of this view.
9627 * @param globalOffset If true is returned, globalOffset holds the dx,dy
9628 * between this view and its root. globalOffet may be null.
9629 * @return true if r is non-empty (i.e. part of the view is visible at the
9630 * root level.
9631 */
9632 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) {
9633 int width = mRight - mLeft;
9634 int height = mBottom - mTop;
9635 if (width > 0 && height > 0) {
9636 r.set(0, 0, width, height);
9637 if (globalOffset != null) {
9638 globalOffset.set(-mScrollX, -mScrollY);
9639 }
9640 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset);
9641 }
9642 return false;
9643 }
9644
9645 public final boolean getGlobalVisibleRect(Rect r) {
9646 return getGlobalVisibleRect(r, null);
9647 }
9648
9649 public final boolean getLocalVisibleRect(Rect r) {
Romain Guyab4c4f4f2012-05-06 13:11:24 -07009650 final Point offset = mAttachInfo != null ? mAttachInfo.mPoint : new Point();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009651 if (getGlobalVisibleRect(r, offset)) {
9652 r.offset(-offset.x, -offset.y); // make r local
9653 return true;
9654 }
9655 return false;
9656 }
9657
9658 /**
9659 * Offset this view's vertical location by the specified number of pixels.
9660 *
9661 * @param offset the number of pixels to offset the view by
9662 */
9663 public void offsetTopAndBottom(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07009664 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07009665 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009666 final boolean matrixIsIdentity = mTransformationInfo == null
9667 || mTransformationInfo.mMatrixIsIdentity;
9668 if (matrixIsIdentity) {
Chet Haase1271e2c2012-04-20 09:54:27 -07009669 if (mDisplayList != null) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009670 invalidateViewProperty(false, false);
9671 } else {
9672 final ViewParent p = mParent;
9673 if (p != null && mAttachInfo != null) {
9674 final Rect r = mAttachInfo.mTmpInvalRect;
9675 int minTop;
9676 int maxBottom;
9677 int yLoc;
9678 if (offset < 0) {
9679 minTop = mTop + offset;
9680 maxBottom = mBottom;
9681 yLoc = offset;
9682 } else {
9683 minTop = mTop;
9684 maxBottom = mBottom + offset;
9685 yLoc = 0;
9686 }
9687 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop);
9688 p.invalidateChild(this, r);
Chet Haase8fbf8d22010-07-30 15:01:32 -07009689 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009690 }
9691 } else {
Chet Haase9d1992d2012-03-13 11:03:25 -07009692 invalidateViewProperty(false, false);
Chet Haasec3aa3612010-06-17 08:50:37 -07009693 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009694
Chet Haasec3aa3612010-06-17 08:50:37 -07009695 mTop += offset;
9696 mBottom += offset;
Chet Haase1271e2c2012-04-20 09:54:27 -07009697 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009698 mDisplayList.offsetTopBottom(offset);
Chet Haase9d1992d2012-03-13 11:03:25 -07009699 invalidateViewProperty(false, false);
9700 } else {
9701 if (!matrixIsIdentity) {
9702 invalidateViewProperty(false, true);
9703 }
9704 invalidateParentIfNeeded();
Chet Haasea1cff502012-02-21 13:43:44 -08009705 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009706 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009707 }
9708
9709 /**
9710 * Offset this view's horizontal location by the specified amount of pixels.
9711 *
9712 * @param offset the numer of pixels to offset the view by
9713 */
9714 public void offsetLeftAndRight(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07009715 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07009716 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009717 final boolean matrixIsIdentity = mTransformationInfo == null
9718 || mTransformationInfo.mMatrixIsIdentity;
9719 if (matrixIsIdentity) {
Chet Haase1271e2c2012-04-20 09:54:27 -07009720 if (mDisplayList != null) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009721 invalidateViewProperty(false, false);
9722 } else {
9723 final ViewParent p = mParent;
9724 if (p != null && mAttachInfo != null) {
9725 final Rect r = mAttachInfo.mTmpInvalRect;
9726 int minLeft;
9727 int maxRight;
9728 if (offset < 0) {
9729 minLeft = mLeft + offset;
9730 maxRight = mRight;
9731 } else {
9732 minLeft = mLeft;
9733 maxRight = mRight + offset;
9734 }
9735 r.set(0, 0, maxRight - minLeft, mBottom - mTop);
9736 p.invalidateChild(this, r);
Chet Haase8fbf8d22010-07-30 15:01:32 -07009737 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009738 }
9739 } else {
Chet Haase9d1992d2012-03-13 11:03:25 -07009740 invalidateViewProperty(false, false);
Chet Haasec3aa3612010-06-17 08:50:37 -07009741 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009742
Chet Haasec3aa3612010-06-17 08:50:37 -07009743 mLeft += offset;
9744 mRight += offset;
Chet Haase1271e2c2012-04-20 09:54:27 -07009745 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009746 mDisplayList.offsetLeftRight(offset);
Chet Haase9d1992d2012-03-13 11:03:25 -07009747 invalidateViewProperty(false, false);
9748 } else {
9749 if (!matrixIsIdentity) {
9750 invalidateViewProperty(false, true);
9751 }
9752 invalidateParentIfNeeded();
Chet Haasea1cff502012-02-21 13:43:44 -08009753 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009754 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009755 }
9756
9757 /**
9758 * Get the LayoutParams associated with this view. All views should have
9759 * layout parameters. These supply parameters to the <i>parent</i> of this
9760 * view specifying how it should be arranged. There are many subclasses of
9761 * ViewGroup.LayoutParams, and these correspond to the different subclasses
9762 * of ViewGroup that are responsible for arranging their children.
Romain Guy01c174b2011-02-22 11:51:06 -08009763 *
9764 * This method may return null if this View is not attached to a parent
9765 * ViewGroup or {@link #setLayoutParams(android.view.ViewGroup.LayoutParams)}
9766 * was not invoked successfully. When a View is attached to a parent
9767 * ViewGroup, this method must not return null.
9768 *
9769 * @return The LayoutParams associated with this view, or null if no
9770 * parameters have been set yet
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009771 */
Konstantin Lopyrev91a7f5f2010-08-10 18:54:54 -07009772 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009773 public ViewGroup.LayoutParams getLayoutParams() {
9774 return mLayoutParams;
9775 }
9776
9777 /**
9778 * Set the layout parameters associated with this view. These supply
9779 * parameters to the <i>parent</i> of this view specifying how it should be
9780 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these
9781 * correspond to the different subclasses of ViewGroup that are responsible
9782 * for arranging their children.
9783 *
Romain Guy01c174b2011-02-22 11:51:06 -08009784 * @param params The layout parameters for this view, cannot be null
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009785 */
9786 public void setLayoutParams(ViewGroup.LayoutParams params) {
9787 if (params == null) {
Romain Guy01c174b2011-02-22 11:51:06 -08009788 throw new NullPointerException("Layout parameters cannot be null");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009789 }
9790 mLayoutParams = params;
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07009791 resolveLayoutParams();
Philip Milned7dd8902012-01-26 16:55:30 -08009792 if (mParent instanceof ViewGroup) {
9793 ((ViewGroup) mParent).onSetLayoutParams(this, params);
9794 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009795 requestLayout();
9796 }
9797
9798 /**
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07009799 * Resolve the layout parameters depending on the resolved layout direction
9800 */
9801 private void resolveLayoutParams() {
9802 if (mLayoutParams != null) {
9803 mLayoutParams.onResolveLayoutDirection(getResolvedLayoutDirection());
9804 }
9805 }
9806
9807 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009808 * Set the scrolled position of your view. This will cause a call to
9809 * {@link #onScrollChanged(int, int, int, int)} and the view will be
9810 * invalidated.
9811 * @param x the x position to scroll to
9812 * @param y the y position to scroll to
9813 */
9814 public void scrollTo(int x, int y) {
9815 if (mScrollX != x || mScrollY != y) {
9816 int oldX = mScrollX;
9817 int oldY = mScrollY;
9818 mScrollX = x;
9819 mScrollY = y;
Romain Guy0fd89bf2011-01-26 15:41:30 -08009820 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009821 onScrollChanged(mScrollX, mScrollY, oldX, oldY);
Mike Cleronf116bf82009-09-27 19:14:12 -07009822 if (!awakenScrollBars()) {
Adam Powelldf3ae4f2012-04-10 18:55:22 -07009823 postInvalidateOnAnimation();
Mike Cleronf116bf82009-09-27 19:14:12 -07009824 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009825 }
9826 }
9827
9828 /**
9829 * Move the scrolled position of your view. This will cause a call to
9830 * {@link #onScrollChanged(int, int, int, int)} and the view will be
9831 * invalidated.
9832 * @param x the amount of pixels to scroll by horizontally
9833 * @param y the amount of pixels to scroll by vertically
9834 */
9835 public void scrollBy(int x, int y) {
9836 scrollTo(mScrollX + x, mScrollY + y);
9837 }
9838
9839 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07009840 * <p>Trigger the scrollbars to draw. When invoked this method starts an
9841 * animation to fade the scrollbars out after a default delay. If a subclass
9842 * provides animated scrolling, the start delay should equal the duration
9843 * of the scrolling animation.</p>
9844 *
9845 * <p>The animation starts only if at least one of the scrollbars is
9846 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and
9847 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
9848 * this method returns true, and false otherwise. If the animation is
9849 * started, this method calls {@link #invalidate()}; in that case the
9850 * caller should not call {@link #invalidate()}.</p>
9851 *
9852 * <p>This method should be invoked every time a subclass directly updates
Mike Cleronfe81d382009-09-28 14:22:16 -07009853 * the scroll parameters.</p>
Mike Cleronf116bf82009-09-27 19:14:12 -07009854 *
9855 * <p>This method is automatically invoked by {@link #scrollBy(int, int)}
9856 * and {@link #scrollTo(int, int)}.</p>
9857 *
9858 * @return true if the animation is played, false otherwise
9859 *
9860 * @see #awakenScrollBars(int)
Mike Cleronf116bf82009-09-27 19:14:12 -07009861 * @see #scrollBy(int, int)
9862 * @see #scrollTo(int, int)
9863 * @see #isHorizontalScrollBarEnabled()
9864 * @see #isVerticalScrollBarEnabled()
9865 * @see #setHorizontalScrollBarEnabled(boolean)
9866 * @see #setVerticalScrollBarEnabled(boolean)
9867 */
9868 protected boolean awakenScrollBars() {
9869 return mScrollCache != null &&
Mike Cleron290947b2009-09-29 18:34:32 -07009870 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true);
Mike Cleronf116bf82009-09-27 19:14:12 -07009871 }
9872
9873 /**
Adam Powell8568c3a2010-04-19 14:26:11 -07009874 * Trigger the scrollbars to draw.
9875 * This method differs from awakenScrollBars() only in its default duration.
9876 * initialAwakenScrollBars() will show the scroll bars for longer than
9877 * usual to give the user more of a chance to notice them.
9878 *
9879 * @return true if the animation is played, false otherwise.
9880 */
9881 private boolean initialAwakenScrollBars() {
9882 return mScrollCache != null &&
9883 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true);
9884 }
9885
9886 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07009887 * <p>
9888 * Trigger the scrollbars to draw. When invoked this method starts an
9889 * animation to fade the scrollbars out after a fixed delay. If a subclass
9890 * provides animated scrolling, the start delay should equal the duration of
9891 * the scrolling animation.
9892 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009893 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009894 * <p>
9895 * The animation starts only if at least one of the scrollbars is enabled,
9896 * as specified by {@link #isHorizontalScrollBarEnabled()} and
9897 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
9898 * this method returns true, and false otherwise. If the animation is
9899 * started, this method calls {@link #invalidate()}; in that case the caller
9900 * should not call {@link #invalidate()}.
9901 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009902 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009903 * <p>
9904 * This method should be invoked everytime a subclass directly updates the
Mike Cleronfe81d382009-09-28 14:22:16 -07009905 * scroll parameters.
Mike Cleronf116bf82009-09-27 19:14:12 -07009906 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009907 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009908 * @param startDelay the delay, in milliseconds, after which the animation
9909 * should start; when the delay is 0, the animation starts
9910 * immediately
9911 * @return true if the animation is played, false otherwise
Joe Malin32736f02011-01-19 16:14:20 -08009912 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009913 * @see #scrollBy(int, int)
9914 * @see #scrollTo(int, int)
9915 * @see #isHorizontalScrollBarEnabled()
9916 * @see #isVerticalScrollBarEnabled()
9917 * @see #setHorizontalScrollBarEnabled(boolean)
9918 * @see #setVerticalScrollBarEnabled(boolean)
9919 */
9920 protected boolean awakenScrollBars(int startDelay) {
Mike Cleron290947b2009-09-29 18:34:32 -07009921 return awakenScrollBars(startDelay, true);
9922 }
Joe Malin32736f02011-01-19 16:14:20 -08009923
Mike Cleron290947b2009-09-29 18:34:32 -07009924 /**
9925 * <p>
9926 * Trigger the scrollbars to draw. When invoked this method starts an
9927 * animation to fade the scrollbars out after a fixed delay. If a subclass
9928 * provides animated scrolling, the start delay should equal the duration of
9929 * the scrolling animation.
9930 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009931 *
Mike Cleron290947b2009-09-29 18:34:32 -07009932 * <p>
9933 * The animation starts only if at least one of the scrollbars is enabled,
9934 * as specified by {@link #isHorizontalScrollBarEnabled()} and
9935 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
9936 * this method returns true, and false otherwise. If the animation is
Joe Malin32736f02011-01-19 16:14:20 -08009937 * started, this method calls {@link #invalidate()} if the invalidate parameter
Mike Cleron290947b2009-09-29 18:34:32 -07009938 * is set to true; in that case the caller
9939 * should not call {@link #invalidate()}.
9940 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009941 *
Mike Cleron290947b2009-09-29 18:34:32 -07009942 * <p>
9943 * This method should be invoked everytime a subclass directly updates the
9944 * scroll parameters.
9945 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009946 *
Mike Cleron290947b2009-09-29 18:34:32 -07009947 * @param startDelay the delay, in milliseconds, after which the animation
9948 * should start; when the delay is 0, the animation starts
9949 * immediately
Joe Malin32736f02011-01-19 16:14:20 -08009950 *
Mike Cleron290947b2009-09-29 18:34:32 -07009951 * @param invalidate Wheter this method should call invalidate
Joe Malin32736f02011-01-19 16:14:20 -08009952 *
Mike Cleron290947b2009-09-29 18:34:32 -07009953 * @return true if the animation is played, false otherwise
Joe Malin32736f02011-01-19 16:14:20 -08009954 *
Mike Cleron290947b2009-09-29 18:34:32 -07009955 * @see #scrollBy(int, int)
9956 * @see #scrollTo(int, int)
9957 * @see #isHorizontalScrollBarEnabled()
9958 * @see #isVerticalScrollBarEnabled()
9959 * @see #setHorizontalScrollBarEnabled(boolean)
9960 * @see #setVerticalScrollBarEnabled(boolean)
9961 */
9962 protected boolean awakenScrollBars(int startDelay, boolean invalidate) {
Mike Cleronf116bf82009-09-27 19:14:12 -07009963 final ScrollabilityCache scrollCache = mScrollCache;
Joe Malin32736f02011-01-19 16:14:20 -08009964
Mike Cleronf116bf82009-09-27 19:14:12 -07009965 if (scrollCache == null || !scrollCache.fadeScrollBars) {
9966 return false;
9967 }
9968
9969 if (scrollCache.scrollBar == null) {
9970 scrollCache.scrollBar = new ScrollBarDrawable();
9971 }
9972
9973 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) {
9974
Mike Cleron290947b2009-09-29 18:34:32 -07009975 if (invalidate) {
9976 // Invalidate to show the scrollbars
Adam Powelldf3ae4f2012-04-10 18:55:22 -07009977 postInvalidateOnAnimation();
Mike Cleron290947b2009-09-29 18:34:32 -07009978 }
Mike Cleronf116bf82009-09-27 19:14:12 -07009979
9980 if (scrollCache.state == ScrollabilityCache.OFF) {
9981 // FIXME: this is copied from WindowManagerService.
9982 // We should get this value from the system when it
9983 // is possible to do so.
9984 final int KEY_REPEAT_FIRST_DELAY = 750;
9985 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay);
9986 }
9987
9988 // Tell mScrollCache when we should start fading. This may
9989 // extend the fade start time if one was already scheduled
Mike Cleron3ecd58c2009-09-28 11:39:02 -07009990 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay;
Mike Cleronf116bf82009-09-27 19:14:12 -07009991 scrollCache.fadeStartTime = fadeStartTime;
9992 scrollCache.state = ScrollabilityCache.ON;
9993
9994 // Schedule our fader to run, unscheduling any old ones first
9995 if (mAttachInfo != null) {
9996 mAttachInfo.mHandler.removeCallbacks(scrollCache);
9997 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime);
9998 }
9999
10000 return true;
10001 }
10002
10003 return false;
10004 }
10005
10006 /**
Chet Haaseaceafe62011-08-26 15:44:33 -070010007 * Do not invalidate views which are not visible and which are not running an animation. They
10008 * will not get drawn and they should not set dirty flags as if they will be drawn
10009 */
10010 private boolean skipInvalidate() {
10011 return (mViewFlags & VISIBILITY_MASK) != VISIBLE && mCurrentAnimation == null &&
10012 (!(mParent instanceof ViewGroup) ||
10013 !((ViewGroup) mParent).isViewTransitioning(this));
10014 }
10015 /**
Joe Fernandez558459f2011-10-13 16:47:36 -070010016 * Mark the area defined by dirty as needing to be drawn. If the view is
Romain Guy5c22a8c2011-05-13 11:48:45 -070010017 * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some point
10018 * in the future. This must be called from a UI thread. To call from a non-UI
10019 * thread, call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010020 *
10021 * WARNING: This method is destructive to dirty.
10022 * @param dirty the rectangle representing the bounds of the dirty region
10023 */
10024 public void invalidate(Rect dirty) {
Chet Haaseaceafe62011-08-26 15:44:33 -070010025 if (skipInvalidate()) {
Chet Haasea68c5cf2011-08-22 14:27:51 -070010026 return;
10027 }
Dianne Hackborn4702a852012-08-17 15:18:29 -070010028 if ((mPrivateFlags & (PFLAG_DRAWN | PFLAG_HAS_BOUNDS)) == (PFLAG_DRAWN | PFLAG_HAS_BOUNDS) ||
10029 (mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == PFLAG_DRAWING_CACHE_VALID ||
10030 (mPrivateFlags & PFLAG_INVALIDATED) != PFLAG_INVALIDATED) {
10031 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID;
10032 mPrivateFlags |= PFLAG_INVALIDATED;
10033 mPrivateFlags |= PFLAG_DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010034 final ViewParent p = mParent;
10035 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -080010036 //noinspection PointlessBooleanExpression,ConstantConditions
10037 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
10038 if (p != null && ai != null && ai.mHardwareAccelerated) {
10039 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070010040 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -080010041 p.invalidateChild(this, null);
10042 return;
10043 }
Romain Guyaf636eb2010-12-09 17:47:21 -080010044 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010045 if (p != null && ai != null) {
10046 final int scrollX = mScrollX;
10047 final int scrollY = mScrollY;
10048 final Rect r = ai.mTmpInvalRect;
10049 r.set(dirty.left - scrollX, dirty.top - scrollY,
10050 dirty.right - scrollX, dirty.bottom - scrollY);
10051 mParent.invalidateChild(this, r);
10052 }
10053 }
10054 }
10055
10056 /**
Joe Fernandez558459f2011-10-13 16:47:36 -070010057 * 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 -080010058 * The coordinates of the dirty rect are relative to the view.
Romain Guy5c22a8c2011-05-13 11:48:45 -070010059 * If the view is visible, {@link #onDraw(android.graphics.Canvas)}
10060 * will be called at some point in the future. This must be called from
10061 * a UI thread. To call from a non-UI thread, call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010062 * @param l the left position of the dirty region
10063 * @param t the top position of the dirty region
10064 * @param r the right position of the dirty region
10065 * @param b the bottom position of the dirty region
10066 */
10067 public void invalidate(int l, int t, int r, int b) {
Chet Haaseaceafe62011-08-26 15:44:33 -070010068 if (skipInvalidate()) {
Chet Haasea68c5cf2011-08-22 14:27:51 -070010069 return;
10070 }
Dianne Hackborn4702a852012-08-17 15:18:29 -070010071 if ((mPrivateFlags & (PFLAG_DRAWN | PFLAG_HAS_BOUNDS)) == (PFLAG_DRAWN | PFLAG_HAS_BOUNDS) ||
10072 (mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == PFLAG_DRAWING_CACHE_VALID ||
10073 (mPrivateFlags & PFLAG_INVALIDATED) != PFLAG_INVALIDATED) {
10074 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID;
10075 mPrivateFlags |= PFLAG_INVALIDATED;
10076 mPrivateFlags |= PFLAG_DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010077 final ViewParent p = mParent;
10078 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -080010079 //noinspection PointlessBooleanExpression,ConstantConditions
10080 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
10081 if (p != null && ai != null && ai.mHardwareAccelerated) {
10082 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070010083 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -080010084 p.invalidateChild(this, null);
10085 return;
10086 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -080010087 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010088 if (p != null && ai != null && l < r && t < b) {
10089 final int scrollX = mScrollX;
10090 final int scrollY = mScrollY;
10091 final Rect tmpr = ai.mTmpInvalRect;
10092 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY);
10093 p.invalidateChild(this, tmpr);
10094 }
10095 }
10096 }
10097
10098 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -070010099 * Invalidate the whole view. If the view is visible,
10100 * {@link #onDraw(android.graphics.Canvas)} will be called at some point in
10101 * the future. This must be called from a UI thread. To call from a non-UI thread,
10102 * call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010103 */
10104 public void invalidate() {
Chet Haaseed032702010-10-01 14:05:54 -070010105 invalidate(true);
10106 }
Joe Malin32736f02011-01-19 16:14:20 -080010107
Chet Haaseed032702010-10-01 14:05:54 -070010108 /**
10109 * This is where the invalidate() work actually happens. A full invalidate()
10110 * causes the drawing cache to be invalidated, but this function can be called with
10111 * invalidateCache set to false to skip that invalidation step for cases that do not
10112 * need it (for example, a component that remains at the same dimensions with the same
10113 * content).
10114 *
10115 * @param invalidateCache Whether the drawing cache for this view should be invalidated as
10116 * well. This is usually true for a full invalidate, but may be set to false if the
10117 * View's contents or dimensions have not changed.
10118 */
Romain Guy849d0a32011-02-01 17:20:48 -080010119 void invalidate(boolean invalidateCache) {
Chet Haaseaceafe62011-08-26 15:44:33 -070010120 if (skipInvalidate()) {
Chet Haasea68c5cf2011-08-22 14:27:51 -070010121 return;
10122 }
Dianne Hackborn4702a852012-08-17 15:18:29 -070010123 if ((mPrivateFlags & (PFLAG_DRAWN | PFLAG_HAS_BOUNDS)) == (PFLAG_DRAWN | PFLAG_HAS_BOUNDS) ||
10124 (invalidateCache && (mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == PFLAG_DRAWING_CACHE_VALID) ||
10125 (mPrivateFlags & PFLAG_INVALIDATED) != PFLAG_INVALIDATED || isOpaque() != mLastIsOpaque) {
Romain Guy0fd89bf2011-01-26 15:41:30 -080010126 mLastIsOpaque = isOpaque();
Dianne Hackborn4702a852012-08-17 15:18:29 -070010127 mPrivateFlags &= ~PFLAG_DRAWN;
10128 mPrivateFlags |= PFLAG_DIRTY;
Chet Haaseed032702010-10-01 14:05:54 -070010129 if (invalidateCache) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070010130 mPrivateFlags |= PFLAG_INVALIDATED;
10131 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID;
Chet Haaseed032702010-10-01 14:05:54 -070010132 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010133 final AttachInfo ai = mAttachInfo;
Chet Haase70d4ba12010-10-06 09:46:45 -070010134 final ViewParent p = mParent;
Romain Guy7d7b5492011-01-24 16:33:45 -080010135 //noinspection PointlessBooleanExpression,ConstantConditions
10136 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
10137 if (p != null && ai != null && ai.mHardwareAccelerated) {
10138 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070010139 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -080010140 p.invalidateChild(this, null);
10141 return;
10142 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -080010143 }
Michael Jurkaebefea42010-11-15 16:04:01 -080010144
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010145 if (p != null && ai != null) {
10146 final Rect r = ai.mTmpInvalRect;
10147 r.set(0, 0, mRight - mLeft, mBottom - mTop);
10148 // Don't call invalidate -- we don't want to internally scroll
10149 // our own bounds
10150 p.invalidateChild(this, r);
10151 }
10152 }
10153 }
10154
10155 /**
Chet Haase9d1992d2012-03-13 11:03:25 -070010156 * Quick invalidation for View property changes (alpha, translationXY, etc.). We don't want to
10157 * set any flags or handle all of the cases handled by the default invalidation methods.
10158 * Instead, we just want to schedule a traversal in ViewRootImpl with the appropriate
10159 * dirty rect. This method calls into fast invalidation methods in ViewGroup that
10160 * walk up the hierarchy, transforming the dirty rect as necessary.
10161 *
10162 * The method also handles normal invalidation logic if display list properties are not
10163 * being used in this view. The invalidateParent and forceRedraw flags are used by that
10164 * backup approach, to handle these cases used in the various property-setting methods.
10165 *
10166 * @param invalidateParent Force a call to invalidateParentCaches() if display list properties
10167 * are not being used in this view
10168 * @param forceRedraw Mark the view as DRAWN to force the invalidation to propagate, if display
10169 * list properties are not being used in this view
10170 */
10171 void invalidateViewProperty(boolean invalidateParent, boolean forceRedraw) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070010172 if (mDisplayList == null || (mPrivateFlags & PFLAG_DRAW_ANIMATION) == PFLAG_DRAW_ANIMATION) {
Chet Haase9d1992d2012-03-13 11:03:25 -070010173 if (invalidateParent) {
10174 invalidateParentCaches();
10175 }
10176 if (forceRedraw) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070010177 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation
Chet Haase9d1992d2012-03-13 11:03:25 -070010178 }
10179 invalidate(false);
10180 } else {
10181 final AttachInfo ai = mAttachInfo;
10182 final ViewParent p = mParent;
10183 if (p != null && ai != null) {
10184 final Rect r = ai.mTmpInvalRect;
10185 r.set(0, 0, mRight - mLeft, mBottom - mTop);
10186 if (mParent instanceof ViewGroup) {
10187 ((ViewGroup) mParent).invalidateChildFast(this, r);
10188 } else {
10189 mParent.invalidateChild(this, r);
10190 }
10191 }
10192 }
10193 }
10194
10195 /**
10196 * Utility method to transform a given Rect by the current matrix of this view.
10197 */
10198 void transformRect(final Rect rect) {
10199 if (!getMatrix().isIdentity()) {
10200 RectF boundingRect = mAttachInfo.mTmpTransformRect;
10201 boundingRect.set(rect);
10202 getMatrix().mapRect(boundingRect);
10203 rect.set((int) (boundingRect.left - 0.5f),
10204 (int) (boundingRect.top - 0.5f),
10205 (int) (boundingRect.right + 0.5f),
10206 (int) (boundingRect.bottom + 0.5f));
10207 }
10208 }
10209
10210 /**
Romain Guy0fd89bf2011-01-26 15:41:30 -080010211 * Used to indicate that the parent of this view should clear its caches. This functionality
Chet Haasedaf98e92011-01-10 14:10:36 -080010212 * is used to force the parent to rebuild its display list (when hardware-accelerated),
10213 * which is necessary when various parent-managed properties of the view change, such as
Romain Guy0fd89bf2011-01-26 15:41:30 -080010214 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method only
10215 * clears the parent caches and does not causes an invalidate event.
Chet Haasedaf98e92011-01-10 14:10:36 -080010216 *
10217 * @hide
10218 */
Romain Guy0fd89bf2011-01-26 15:41:30 -080010219 protected void invalidateParentCaches() {
10220 if (mParent instanceof View) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070010221 ((View) mParent).mPrivateFlags |= PFLAG_INVALIDATED;
Romain Guy0fd89bf2011-01-26 15:41:30 -080010222 }
10223 }
Joe Malin32736f02011-01-19 16:14:20 -080010224
Romain Guy0fd89bf2011-01-26 15:41:30 -080010225 /**
10226 * Used to indicate that the parent of this view should be invalidated. This functionality
10227 * is used to force the parent to rebuild its display list (when hardware-accelerated),
10228 * which is necessary when various parent-managed properties of the view change, such as
10229 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method will propagate
10230 * an invalidation event to the parent.
10231 *
10232 * @hide
10233 */
10234 protected void invalidateParentIfNeeded() {
Chet Haasedaf98e92011-01-10 14:10:36 -080010235 if (isHardwareAccelerated() && mParent instanceof View) {
Romain Guy0fd89bf2011-01-26 15:41:30 -080010236 ((View) mParent).invalidate(true);
Chet Haasedaf98e92011-01-10 14:10:36 -080010237 }
10238 }
10239
10240 /**
Romain Guy24443ea2009-05-11 11:56:30 -070010241 * Indicates whether this View is opaque. An opaque View guarantees that it will
10242 * draw all the pixels overlapping its bounds using a fully opaque color.
10243 *
10244 * Subclasses of View should override this method whenever possible to indicate
10245 * whether an instance is opaque. Opaque Views are treated in a special way by
10246 * the View hierarchy, possibly allowing it to perform optimizations during
10247 * invalidate/draw passes.
Romain Guy8506ab42009-06-11 17:35:47 -070010248 *
Romain Guy24443ea2009-05-11 11:56:30 -070010249 * @return True if this View is guaranteed to be fully opaque, false otherwise.
Romain Guy24443ea2009-05-11 11:56:30 -070010250 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070010251 @ViewDebug.ExportedProperty(category = "drawing")
Romain Guy24443ea2009-05-11 11:56:30 -070010252 public boolean isOpaque() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070010253 return (mPrivateFlags & PFLAG_OPAQUE_MASK) == PFLAG_OPAQUE_MASK &&
Romain Guyf8773082012-07-12 18:01:00 -070010254 ((mTransformationInfo != null ? mTransformationInfo.mAlpha : 1.0f) >= 1.0f);
Romain Guy8f1344f52009-05-15 16:03:59 -070010255 }
10256
Adam Powell20232d02010-12-08 21:08:53 -080010257 /**
10258 * @hide
10259 */
10260 protected void computeOpaqueFlags() {
Romain Guy8f1344f52009-05-15 16:03:59 -070010261 // Opaque if:
10262 // - Has a background
10263 // - Background is opaque
10264 // - Doesn't have scrollbars or scrollbars are inside overlay
10265
Philip Milne6c8ea062012-04-03 17:38:43 -070010266 if (mBackground != null && mBackground.getOpacity() == PixelFormat.OPAQUE) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070010267 mPrivateFlags |= PFLAG_OPAQUE_BACKGROUND;
Romain Guy8f1344f52009-05-15 16:03:59 -070010268 } else {
Dianne Hackborn4702a852012-08-17 15:18:29 -070010269 mPrivateFlags &= ~PFLAG_OPAQUE_BACKGROUND;
Romain Guy8f1344f52009-05-15 16:03:59 -070010270 }
10271
10272 final int flags = mViewFlags;
10273 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) ||
10274 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070010275 mPrivateFlags |= PFLAG_OPAQUE_SCROLLBARS;
Romain Guy8f1344f52009-05-15 16:03:59 -070010276 } else {
Dianne Hackborn4702a852012-08-17 15:18:29 -070010277 mPrivateFlags &= ~PFLAG_OPAQUE_SCROLLBARS;
Romain Guy8f1344f52009-05-15 16:03:59 -070010278 }
10279 }
10280
10281 /**
10282 * @hide
10283 */
10284 protected boolean hasOpaqueScrollbars() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070010285 return (mPrivateFlags & PFLAG_OPAQUE_SCROLLBARS) == PFLAG_OPAQUE_SCROLLBARS;
Romain Guy24443ea2009-05-11 11:56:30 -070010286 }
10287
10288 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010289 * @return A handler associated with the thread running the View. This
10290 * handler can be used to pump events in the UI events queue.
10291 */
10292 public Handler getHandler() {
10293 if (mAttachInfo != null) {
10294 return mAttachInfo.mHandler;
10295 }
10296 return null;
10297 }
10298
10299 /**
Jeff Browna175a5b2012-02-15 19:18:31 -080010300 * Gets the view root associated with the View.
10301 * @return The view root, or null if none.
10302 * @hide
10303 */
10304 public ViewRootImpl getViewRootImpl() {
10305 if (mAttachInfo != null) {
10306 return mAttachInfo.mViewRootImpl;
10307 }
10308 return null;
10309 }
10310
10311 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010312 * <p>Causes the Runnable to be added to the message queue.
10313 * The runnable will be run on the user interface thread.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010314 *
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>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010317 *
10318 * @param action The Runnable that will be executed.
10319 *
10320 * @return Returns true if the Runnable was successfully placed in to the
10321 * message queue. Returns false on failure, usually because the
10322 * looper processing the message queue is exiting.
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010323 *
10324 * @see #postDelayed
10325 * @see #removeCallbacks
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010326 */
10327 public boolean post(Runnable action) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010328 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010329 if (attachInfo != null) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010330 return attachInfo.mHandler.post(action);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010331 }
Jeff Browna175a5b2012-02-15 19:18:31 -080010332 // Assume that post will succeed later
10333 ViewRootImpl.getRunQueue().post(action);
10334 return true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010335 }
10336
10337 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010338 * <p>Causes the Runnable to be added to the message queue, to be run
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010339 * after the specified amount of time elapses.
Romain Guye63a4f32011-08-11 11:33:31 -070010340 * The runnable will be run on the user interface thread.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010341 *
Romain Guye63a4f32011-08-11 11:33:31 -070010342 * <p>This method can be invoked from outside of the UI thread
10343 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010344 *
10345 * @param action The Runnable that will be executed.
10346 * @param delayMillis The delay (in milliseconds) until the Runnable
10347 * will be executed.
10348 *
10349 * @return true if the Runnable was successfully placed in to the
10350 * message queue. Returns false on failure, usually because the
10351 * looper processing the message queue is exiting. Note that a
10352 * result of true does not mean the Runnable will be processed --
10353 * if the looper is quit before the delivery time of the message
10354 * occurs then the message will be dropped.
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010355 *
10356 * @see #post
10357 * @see #removeCallbacks
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010358 */
10359 public boolean postDelayed(Runnable action, long delayMillis) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010360 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010361 if (attachInfo != null) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010362 return attachInfo.mHandler.postDelayed(action, delayMillis);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010363 }
Jeff Browna175a5b2012-02-15 19:18:31 -080010364 // Assume that post will succeed later
10365 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis);
10366 return true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010367 }
10368
10369 /**
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010370 * <p>Causes the Runnable to execute on the next animation time step.
10371 * The runnable will be run on the user interface thread.</p>
10372 *
10373 * <p>This method can be invoked from outside of the UI thread
10374 * only when this View is attached to a window.</p>
10375 *
10376 * @param action The Runnable that will be executed.
10377 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010378 * @see #postOnAnimationDelayed
10379 * @see #removeCallbacks
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010380 */
10381 public void postOnAnimation(Runnable action) {
10382 final AttachInfo attachInfo = mAttachInfo;
10383 if (attachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070010384 attachInfo.mViewRootImpl.mChoreographer.postCallback(
10385 Choreographer.CALLBACK_ANIMATION, action, null);
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010386 } else {
10387 // Assume that post will succeed later
10388 ViewRootImpl.getRunQueue().post(action);
10389 }
10390 }
10391
10392 /**
10393 * <p>Causes the Runnable to execute on the next animation time step,
10394 * after the specified amount of time elapses.
10395 * The runnable will be run on the user interface thread.</p>
10396 *
10397 * <p>This method can be invoked from outside of the UI thread
10398 * only when this View is attached to a window.</p>
10399 *
10400 * @param action The Runnable that will be executed.
10401 * @param delayMillis The delay (in milliseconds) until the Runnable
10402 * will be executed.
10403 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010404 * @see #postOnAnimation
10405 * @see #removeCallbacks
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010406 */
10407 public void postOnAnimationDelayed(Runnable action, long delayMillis) {
10408 final AttachInfo attachInfo = mAttachInfo;
10409 if (attachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070010410 attachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed(
10411 Choreographer.CALLBACK_ANIMATION, action, null, delayMillis);
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010412 } else {
10413 // Assume that post will succeed later
10414 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis);
10415 }
10416 }
10417
10418 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010419 * <p>Removes the specified Runnable from the message queue.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010420 *
Romain Guye63a4f32011-08-11 11:33:31 -070010421 * <p>This method can be invoked from outside of the UI thread
10422 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010423 *
10424 * @param action The Runnable to remove from the message handling queue
10425 *
10426 * @return true if this view could ask the Handler to remove the Runnable,
10427 * false otherwise. When the returned value is true, the Runnable
10428 * may or may not have been actually removed from the message queue
10429 * (for instance, if the Runnable was not in the queue already.)
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010430 *
10431 * @see #post
10432 * @see #postDelayed
10433 * @see #postOnAnimation
10434 * @see #postOnAnimationDelayed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010435 */
10436 public boolean removeCallbacks(Runnable action) {
Jeff Brown43ea54b2012-03-09 14:37:48 -080010437 if (action != null) {
10438 final AttachInfo attachInfo = mAttachInfo;
10439 if (attachInfo != null) {
10440 attachInfo.mHandler.removeCallbacks(action);
Jeff Brownebb2d8d2012-03-23 17:14:34 -070010441 attachInfo.mViewRootImpl.mChoreographer.removeCallbacks(
10442 Choreographer.CALLBACK_ANIMATION, action, null);
Jeff Brown43ea54b2012-03-09 14:37:48 -080010443 } else {
10444 // Assume that post will succeed later
10445 ViewRootImpl.getRunQueue().removeCallbacks(action);
10446 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010447 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010448 return true;
10449 }
10450
10451 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010452 * <p>Cause an invalidate to happen on a subsequent cycle through the event loop.
10453 * Use this to invalidate the View from a non-UI thread.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010454 *
Romain Guye63a4f32011-08-11 11:33:31 -070010455 * <p>This method can be invoked from outside of the UI thread
10456 * only when this View is attached to a window.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010457 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010458 * @see #invalidate()
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010459 * @see #postInvalidateDelayed(long)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010460 */
10461 public void postInvalidate() {
10462 postInvalidateDelayed(0);
10463 }
10464
10465 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010466 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle
10467 * through the event loop. Use this to invalidate the View from a non-UI thread.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010468 *
Romain Guye63a4f32011-08-11 11:33:31 -070010469 * <p>This method can be invoked from outside of the UI thread
10470 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010471 *
10472 * @param left The left coordinate of the rectangle to invalidate.
10473 * @param top The top coordinate of the rectangle to invalidate.
10474 * @param right The right coordinate of the rectangle to invalidate.
10475 * @param bottom The bottom coordinate of the rectangle to invalidate.
10476 *
10477 * @see #invalidate(int, int, int, int)
10478 * @see #invalidate(Rect)
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010479 * @see #postInvalidateDelayed(long, int, int, int, int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010480 */
10481 public void postInvalidate(int left, int top, int right, int bottom) {
10482 postInvalidateDelayed(0, left, top, right, bottom);
10483 }
10484
10485 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010486 * <p>Cause an invalidate to happen on a subsequent cycle through the event
10487 * loop. Waits for the specified amount of time.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010488 *
Romain Guye63a4f32011-08-11 11:33:31 -070010489 * <p>This method can be invoked from outside of the UI thread
10490 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010491 *
10492 * @param delayMilliseconds the duration in milliseconds to delay the
10493 * invalidation by
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010494 *
10495 * @see #invalidate()
10496 * @see #postInvalidate()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010497 */
10498 public void postInvalidateDelayed(long delayMilliseconds) {
10499 // We try only with the AttachInfo because there's no point in invalidating
10500 // if we are not attached to our window
Jeff Browna175a5b2012-02-15 19:18:31 -080010501 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010502 if (attachInfo != null) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010503 attachInfo.mViewRootImpl.dispatchInvalidateDelayed(this, delayMilliseconds);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010504 }
10505 }
10506
10507 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010508 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle
10509 * through the event loop. Waits for the specified amount of time.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010510 *
Romain Guye63a4f32011-08-11 11:33:31 -070010511 * <p>This method can be invoked from outside of the UI thread
10512 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010513 *
10514 * @param delayMilliseconds the duration in milliseconds to delay the
10515 * invalidation by
10516 * @param left The left coordinate of the rectangle to invalidate.
10517 * @param top The top coordinate of the rectangle to invalidate.
10518 * @param right The right coordinate of the rectangle to invalidate.
10519 * @param bottom The bottom coordinate of the rectangle to invalidate.
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010520 *
10521 * @see #invalidate(int, int, int, int)
10522 * @see #invalidate(Rect)
10523 * @see #postInvalidate(int, int, int, int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010524 */
10525 public void postInvalidateDelayed(long delayMilliseconds, int left, int top,
10526 int right, int bottom) {
10527
10528 // We try only with the AttachInfo because there's no point in invalidating
10529 // if we are not attached to our window
Jeff Browna175a5b2012-02-15 19:18:31 -080010530 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010531 if (attachInfo != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010532 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
10533 info.target = this;
10534 info.left = left;
10535 info.top = top;
10536 info.right = right;
10537 info.bottom = bottom;
10538
Jeff Browna175a5b2012-02-15 19:18:31 -080010539 attachInfo.mViewRootImpl.dispatchInvalidateRectDelayed(info, delayMilliseconds);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010540 }
10541 }
10542
10543 /**
Jeff Brown6cb7b462012-03-05 13:21:17 -080010544 * <p>Cause an invalidate to happen on the next animation time step, typically the
10545 * next display frame.</p>
10546 *
10547 * <p>This method can be invoked from outside of the UI thread
10548 * only when this View is attached to a window.</p>
10549 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010550 * @see #invalidate()
Jeff Brown6cb7b462012-03-05 13:21:17 -080010551 */
10552 public void postInvalidateOnAnimation() {
10553 // We try only with the AttachInfo because there's no point in invalidating
10554 // if we are not attached to our window
10555 final AttachInfo attachInfo = mAttachInfo;
10556 if (attachInfo != null) {
10557 attachInfo.mViewRootImpl.dispatchInvalidateOnAnimation(this);
10558 }
10559 }
10560
10561 /**
10562 * <p>Cause an invalidate of the specified area to happen on the next animation
10563 * time step, typically the next display frame.</p>
10564 *
10565 * <p>This method can be invoked from outside of the UI thread
10566 * only when this View is attached to a window.</p>
10567 *
10568 * @param left The left coordinate of the rectangle to invalidate.
10569 * @param top The top coordinate of the rectangle to invalidate.
10570 * @param right The right coordinate of the rectangle to invalidate.
10571 * @param bottom The bottom coordinate of the rectangle to invalidate.
10572 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010573 * @see #invalidate(int, int, int, int)
10574 * @see #invalidate(Rect)
Jeff Brown6cb7b462012-03-05 13:21:17 -080010575 */
10576 public void postInvalidateOnAnimation(int left, int top, int right, int bottom) {
10577 // We try only with the AttachInfo because there's no point in invalidating
10578 // if we are not attached to our window
10579 final AttachInfo attachInfo = mAttachInfo;
10580 if (attachInfo != null) {
10581 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
10582 info.target = this;
10583 info.left = left;
10584 info.top = top;
10585 info.right = right;
10586 info.bottom = bottom;
10587
10588 attachInfo.mViewRootImpl.dispatchInvalidateRectOnAnimation(info);
10589 }
10590 }
10591
10592 /**
Svetoslav Ganova0156172011-06-26 17:55:44 -070010593 * Post a callback to send a {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} event.
10594 * This event is sent at most once every
10595 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}.
10596 */
10597 private void postSendViewScrolledAccessibilityEventCallback() {
10598 if (mSendViewScrolledAccessibilityEvent == null) {
10599 mSendViewScrolledAccessibilityEvent = new SendViewScrolledAccessibilityEvent();
10600 }
10601 if (!mSendViewScrolledAccessibilityEvent.mIsPending) {
10602 mSendViewScrolledAccessibilityEvent.mIsPending = true;
10603 postDelayed(mSendViewScrolledAccessibilityEvent,
10604 ViewConfiguration.getSendRecurringAccessibilityEventsInterval());
10605 }
10606 }
10607
10608 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010609 * Called by a parent to request that a child update its values for mScrollX
10610 * and mScrollY if necessary. This will typically be done if the child is
10611 * animating a scroll using a {@link android.widget.Scroller Scroller}
10612 * object.
10613 */
10614 public void computeScroll() {
10615 }
10616
10617 /**
10618 * <p>Indicate whether the horizontal edges are faded when the view is
10619 * scrolled horizontally.</p>
10620 *
10621 * @return true if the horizontal edges should are faded on scroll, false
10622 * otherwise
10623 *
10624 * @see #setHorizontalFadingEdgeEnabled(boolean)
Philip Milne6c8ea062012-04-03 17:38:43 -070010625 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010626 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010627 */
10628 public boolean isHorizontalFadingEdgeEnabled() {
10629 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL;
10630 }
10631
10632 /**
10633 * <p>Define whether the horizontal edges should be faded when this view
10634 * is scrolled horizontally.</p>
10635 *
10636 * @param horizontalFadingEdgeEnabled true if the horizontal edges should
10637 * be faded when the view is scrolled
10638 * horizontally
10639 *
10640 * @see #isHorizontalFadingEdgeEnabled()
Philip Milne6c8ea062012-04-03 17:38:43 -070010641 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010642 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010643 */
10644 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) {
10645 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) {
10646 if (horizontalFadingEdgeEnabled) {
10647 initScrollCache();
10648 }
10649
10650 mViewFlags ^= FADING_EDGE_HORIZONTAL;
10651 }
10652 }
10653
10654 /**
10655 * <p>Indicate whether the vertical edges are faded when the view is
10656 * scrolled horizontally.</p>
10657 *
10658 * @return true if the vertical edges should are faded on scroll, false
10659 * otherwise
10660 *
10661 * @see #setVerticalFadingEdgeEnabled(boolean)
Philip Milne6c8ea062012-04-03 17:38:43 -070010662 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010663 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010664 */
10665 public boolean isVerticalFadingEdgeEnabled() {
10666 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL;
10667 }
10668
10669 /**
10670 * <p>Define whether the vertical edges should be faded when this view
10671 * is scrolled vertically.</p>
10672 *
10673 * @param verticalFadingEdgeEnabled true if the vertical edges should
10674 * be faded when the view is scrolled
10675 * vertically
10676 *
10677 * @see #isVerticalFadingEdgeEnabled()
Philip Milne6c8ea062012-04-03 17:38:43 -070010678 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010679 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010680 */
10681 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) {
10682 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) {
10683 if (verticalFadingEdgeEnabled) {
10684 initScrollCache();
10685 }
10686
10687 mViewFlags ^= FADING_EDGE_VERTICAL;
10688 }
10689 }
10690
10691 /**
10692 * Returns the strength, or intensity, of the top faded edge. The strength is
10693 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10694 * returns 0.0 or 1.0 but no value in between.
10695 *
10696 * Subclasses should override this method to provide a smoother fade transition
10697 * when scrolling occurs.
10698 *
10699 * @return the intensity of the top fade as a float between 0.0f and 1.0f
10700 */
10701 protected float getTopFadingEdgeStrength() {
10702 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f;
10703 }
10704
10705 /**
10706 * Returns the strength, or intensity, of the bottom faded edge. The strength is
10707 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10708 * returns 0.0 or 1.0 but no value in between.
10709 *
10710 * Subclasses should override this method to provide a smoother fade transition
10711 * when scrolling occurs.
10712 *
10713 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f
10714 */
10715 protected float getBottomFadingEdgeStrength() {
10716 return computeVerticalScrollOffset() + computeVerticalScrollExtent() <
10717 computeVerticalScrollRange() ? 1.0f : 0.0f;
10718 }
10719
10720 /**
10721 * Returns the strength, or intensity, of the left faded edge. The strength is
10722 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10723 * returns 0.0 or 1.0 but no value in between.
10724 *
10725 * Subclasses should override this method to provide a smoother fade transition
10726 * when scrolling occurs.
10727 *
10728 * @return the intensity of the left fade as a float between 0.0f and 1.0f
10729 */
10730 protected float getLeftFadingEdgeStrength() {
10731 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f;
10732 }
10733
10734 /**
10735 * Returns the strength, or intensity, of the right faded edge. The strength is
10736 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10737 * returns 0.0 or 1.0 but no value in between.
10738 *
10739 * Subclasses should override this method to provide a smoother fade transition
10740 * when scrolling occurs.
10741 *
10742 * @return the intensity of the right fade as a float between 0.0f and 1.0f
10743 */
10744 protected float getRightFadingEdgeStrength() {
10745 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() <
10746 computeHorizontalScrollRange() ? 1.0f : 0.0f;
10747 }
10748
10749 /**
10750 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The
10751 * scrollbar is not drawn by default.</p>
10752 *
10753 * @return true if the horizontal scrollbar should be painted, false
10754 * otherwise
10755 *
10756 * @see #setHorizontalScrollBarEnabled(boolean)
10757 */
10758 public boolean isHorizontalScrollBarEnabled() {
10759 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
10760 }
10761
10762 /**
10763 * <p>Define whether the horizontal scrollbar should be drawn or not. The
10764 * scrollbar is not drawn by default.</p>
10765 *
10766 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should
10767 * be painted
10768 *
10769 * @see #isHorizontalScrollBarEnabled()
10770 */
10771 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) {
10772 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) {
10773 mViewFlags ^= SCROLLBARS_HORIZONTAL;
Romain Guy8f1344f52009-05-15 16:03:59 -070010774 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070010775 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010776 }
10777 }
10778
10779 /**
10780 * <p>Indicate whether the vertical scrollbar should be drawn or not. The
10781 * scrollbar is not drawn by default.</p>
10782 *
10783 * @return true if the vertical scrollbar should be painted, false
10784 * otherwise
10785 *
10786 * @see #setVerticalScrollBarEnabled(boolean)
10787 */
10788 public boolean isVerticalScrollBarEnabled() {
10789 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL;
10790 }
10791
10792 /**
10793 * <p>Define whether the vertical scrollbar should be drawn or not. The
10794 * scrollbar is not drawn by default.</p>
10795 *
10796 * @param verticalScrollBarEnabled true if the vertical scrollbar should
10797 * be painted
10798 *
10799 * @see #isVerticalScrollBarEnabled()
10800 */
10801 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) {
10802 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) {
10803 mViewFlags ^= SCROLLBARS_VERTICAL;
Romain Guy8f1344f52009-05-15 16:03:59 -070010804 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070010805 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010806 }
10807 }
10808
Adam Powell20232d02010-12-08 21:08:53 -080010809 /**
10810 * @hide
10811 */
10812 protected void recomputePadding() {
Fabrice Di Meglio016456e2012-07-17 20:35:48 -070010813 internalSetPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010814 }
Joe Malin32736f02011-01-19 16:14:20 -080010815
Mike Cleronfe81d382009-09-28 14:22:16 -070010816 /**
10817 * Define whether scrollbars will fade when the view is not scrolling.
Joe Malin32736f02011-01-19 16:14:20 -080010818 *
Mike Cleronfe81d382009-09-28 14:22:16 -070010819 * @param fadeScrollbars wheter to enable fading
Joe Malin32736f02011-01-19 16:14:20 -080010820 *
Philip Milne6c8ea062012-04-03 17:38:43 -070010821 * @attr ref android.R.styleable#View_fadeScrollbars
Mike Cleronfe81d382009-09-28 14:22:16 -070010822 */
10823 public void setScrollbarFadingEnabled(boolean fadeScrollbars) {
10824 initScrollCache();
10825 final ScrollabilityCache scrollabilityCache = mScrollCache;
10826 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Mike Cleron52f0a642009-09-28 18:21:37 -070010827 if (fadeScrollbars) {
10828 scrollabilityCache.state = ScrollabilityCache.OFF;
10829 } else {
Mike Cleronfe81d382009-09-28 14:22:16 -070010830 scrollabilityCache.state = ScrollabilityCache.ON;
10831 }
10832 }
Joe Malin32736f02011-01-19 16:14:20 -080010833
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010834 /**
Joe Malin32736f02011-01-19 16:14:20 -080010835 *
Mike Cleron52f0a642009-09-28 18:21:37 -070010836 * Returns true if scrollbars will fade when this view is not scrolling
Joe Malin32736f02011-01-19 16:14:20 -080010837 *
Mike Cleron52f0a642009-09-28 18:21:37 -070010838 * @return true if scrollbar fading is enabled
Philip Milne6c8ea062012-04-03 17:38:43 -070010839 *
10840 * @attr ref android.R.styleable#View_fadeScrollbars
Mike Cleron52f0a642009-09-28 18:21:37 -070010841 */
10842 public boolean isScrollbarFadingEnabled() {
Joe Malin32736f02011-01-19 16:14:20 -080010843 return mScrollCache != null && mScrollCache.fadeScrollBars;
Mike Cleron52f0a642009-09-28 18:21:37 -070010844 }
Joe Malin32736f02011-01-19 16:14:20 -080010845
Mike Cleron52f0a642009-09-28 18:21:37 -070010846 /**
Philip Milne6c8ea062012-04-03 17:38:43 -070010847 *
10848 * Returns the delay before scrollbars fade.
10849 *
10850 * @return the delay before scrollbars fade
10851 *
10852 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade
10853 */
10854 public int getScrollBarDefaultDelayBeforeFade() {
10855 return mScrollCache == null ? ViewConfiguration.getScrollDefaultDelay() :
10856 mScrollCache.scrollBarDefaultDelayBeforeFade;
10857 }
10858
10859 /**
10860 * Define the delay before scrollbars fade.
10861 *
10862 * @param scrollBarDefaultDelayBeforeFade - the delay before scrollbars fade
10863 *
10864 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade
10865 */
10866 public void setScrollBarDefaultDelayBeforeFade(int scrollBarDefaultDelayBeforeFade) {
10867 getScrollCache().scrollBarDefaultDelayBeforeFade = scrollBarDefaultDelayBeforeFade;
10868 }
10869
10870 /**
10871 *
10872 * Returns the scrollbar fade duration.
10873 *
10874 * @return the scrollbar fade duration
10875 *
10876 * @attr ref android.R.styleable#View_scrollbarFadeDuration
10877 */
10878 public int getScrollBarFadeDuration() {
10879 return mScrollCache == null ? ViewConfiguration.getScrollBarFadeDuration() :
10880 mScrollCache.scrollBarFadeDuration;
10881 }
10882
10883 /**
10884 * Define the scrollbar fade duration.
10885 *
10886 * @param scrollBarFadeDuration - the scrollbar fade duration
10887 *
10888 * @attr ref android.R.styleable#View_scrollbarFadeDuration
10889 */
10890 public void setScrollBarFadeDuration(int scrollBarFadeDuration) {
10891 getScrollCache().scrollBarFadeDuration = scrollBarFadeDuration;
10892 }
10893
10894 /**
10895 *
10896 * Returns the scrollbar size.
10897 *
10898 * @return the scrollbar size
10899 *
10900 * @attr ref android.R.styleable#View_scrollbarSize
10901 */
10902 public int getScrollBarSize() {
Romain Guyeb378892012-04-12 11:33:14 -070010903 return mScrollCache == null ? ViewConfiguration.get(mContext).getScaledScrollBarSize() :
Philip Milne6c8ea062012-04-03 17:38:43 -070010904 mScrollCache.scrollBarSize;
10905 }
10906
10907 /**
10908 * Define the scrollbar size.
10909 *
10910 * @param scrollBarSize - the scrollbar size
10911 *
10912 * @attr ref android.R.styleable#View_scrollbarSize
10913 */
10914 public void setScrollBarSize(int scrollBarSize) {
10915 getScrollCache().scrollBarSize = scrollBarSize;
10916 }
10917
10918 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010919 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or
10920 * inset. When inset, they add to the padding of the view. And the scrollbars
10921 * can be drawn inside the padding area or on the edge of the view. For example,
10922 * if a view has a background drawable and you want to draw the scrollbars
10923 * inside the padding specified by the drawable, you can use
10924 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to
10925 * appear at the edge of the view, ignoring the padding, then you can use
10926 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p>
10927 * @param style the style of the scrollbars. Should be one of
10928 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET,
10929 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.
10930 * @see #SCROLLBARS_INSIDE_OVERLAY
10931 * @see #SCROLLBARS_INSIDE_INSET
10932 * @see #SCROLLBARS_OUTSIDE_OVERLAY
10933 * @see #SCROLLBARS_OUTSIDE_INSET
Philip Milne6c8ea062012-04-03 17:38:43 -070010934 *
10935 * @attr ref android.R.styleable#View_scrollbarStyle
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010936 */
10937 public void setScrollBarStyle(int style) {
10938 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) {
10939 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK);
Romain Guy8f1344f52009-05-15 16:03:59 -070010940 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070010941 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010942 }
10943 }
10944
10945 /**
10946 * <p>Returns the current scrollbar style.</p>
10947 * @return the current scrollbar style
10948 * @see #SCROLLBARS_INSIDE_OVERLAY
10949 * @see #SCROLLBARS_INSIDE_INSET
10950 * @see #SCROLLBARS_OUTSIDE_OVERLAY
10951 * @see #SCROLLBARS_OUTSIDE_INSET
Philip Milne6c8ea062012-04-03 17:38:43 -070010952 *
10953 * @attr ref android.R.styleable#View_scrollbarStyle
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010954 */
Jeff Sharkey010d7e52011-08-08 21:05:02 -070010955 @ViewDebug.ExportedProperty(mapping = {
10956 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_OVERLAY, to = "INSIDE_OVERLAY"),
10957 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_INSET, to = "INSIDE_INSET"),
10958 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_OVERLAY, to = "OUTSIDE_OVERLAY"),
10959 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_INSET, to = "OUTSIDE_INSET")
10960 })
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010961 public int getScrollBarStyle() {
10962 return mViewFlags & SCROLLBARS_STYLE_MASK;
10963 }
10964
10965 /**
10966 * <p>Compute the horizontal range that the horizontal scrollbar
10967 * represents.</p>
10968 *
10969 * <p>The range is expressed in arbitrary units that must be the same as the
10970 * units used by {@link #computeHorizontalScrollExtent()} and
10971 * {@link #computeHorizontalScrollOffset()}.</p>
10972 *
10973 * <p>The default range is the drawing width of this view.</p>
10974 *
10975 * @return the total horizontal range represented by the horizontal
10976 * scrollbar
10977 *
10978 * @see #computeHorizontalScrollExtent()
10979 * @see #computeHorizontalScrollOffset()
10980 * @see android.widget.ScrollBarDrawable
10981 */
10982 protected int computeHorizontalScrollRange() {
10983 return getWidth();
10984 }
10985
10986 /**
10987 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb
10988 * within the horizontal range. This value is used to compute the position
10989 * of the thumb within the scrollbar's track.</p>
10990 *
10991 * <p>The range is expressed in arbitrary units that must be the same as the
10992 * units used by {@link #computeHorizontalScrollRange()} and
10993 * {@link #computeHorizontalScrollExtent()}.</p>
10994 *
10995 * <p>The default offset is the scroll offset of this view.</p>
10996 *
10997 * @return the horizontal offset of the scrollbar's thumb
10998 *
10999 * @see #computeHorizontalScrollRange()
11000 * @see #computeHorizontalScrollExtent()
11001 * @see android.widget.ScrollBarDrawable
11002 */
11003 protected int computeHorizontalScrollOffset() {
11004 return mScrollX;
11005 }
11006
11007 /**
11008 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb
11009 * within the horizontal range. This value is used to compute the length
11010 * of the thumb within the scrollbar's track.</p>
11011 *
11012 * <p>The range is expressed in arbitrary units that must be the same as the
11013 * units used by {@link #computeHorizontalScrollRange()} and
11014 * {@link #computeHorizontalScrollOffset()}.</p>
11015 *
11016 * <p>The default extent is the drawing width of this view.</p>
11017 *
11018 * @return the horizontal extent of the scrollbar's thumb
11019 *
11020 * @see #computeHorizontalScrollRange()
11021 * @see #computeHorizontalScrollOffset()
11022 * @see android.widget.ScrollBarDrawable
11023 */
11024 protected int computeHorizontalScrollExtent() {
11025 return getWidth();
11026 }
11027
11028 /**
11029 * <p>Compute the vertical range that the vertical scrollbar represents.</p>
11030 *
11031 * <p>The range is expressed in arbitrary units that must be the same as the
11032 * units used by {@link #computeVerticalScrollExtent()} and
11033 * {@link #computeVerticalScrollOffset()}.</p>
11034 *
11035 * @return the total vertical range represented by the vertical scrollbar
11036 *
11037 * <p>The default range is the drawing height of this view.</p>
11038 *
11039 * @see #computeVerticalScrollExtent()
11040 * @see #computeVerticalScrollOffset()
11041 * @see android.widget.ScrollBarDrawable
11042 */
11043 protected int computeVerticalScrollRange() {
11044 return getHeight();
11045 }
11046
11047 /**
11048 * <p>Compute the vertical offset of the vertical scrollbar's thumb
11049 * within the horizontal range. This value is used to compute the position
11050 * of the thumb within the scrollbar's track.</p>
11051 *
11052 * <p>The range is expressed in arbitrary units that must be the same as the
11053 * units used by {@link #computeVerticalScrollRange()} and
11054 * {@link #computeVerticalScrollExtent()}.</p>
11055 *
11056 * <p>The default offset is the scroll offset of this view.</p>
11057 *
11058 * @return the vertical offset of the scrollbar's thumb
11059 *
11060 * @see #computeVerticalScrollRange()
11061 * @see #computeVerticalScrollExtent()
11062 * @see android.widget.ScrollBarDrawable
11063 */
11064 protected int computeVerticalScrollOffset() {
11065 return mScrollY;
11066 }
11067
11068 /**
11069 * <p>Compute the vertical extent of the horizontal scrollbar's thumb
11070 * within the vertical range. This value is used to compute the length
11071 * of the thumb within the scrollbar's track.</p>
11072 *
11073 * <p>The range is expressed in arbitrary units that must be the same as the
Gilles Debunne52964242010-02-24 11:05:19 -080011074 * units used by {@link #computeVerticalScrollRange()} and
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011075 * {@link #computeVerticalScrollOffset()}.</p>
11076 *
11077 * <p>The default extent is the drawing height of this view.</p>
11078 *
11079 * @return the vertical extent of the scrollbar's thumb
11080 *
11081 * @see #computeVerticalScrollRange()
11082 * @see #computeVerticalScrollOffset()
11083 * @see android.widget.ScrollBarDrawable
11084 */
11085 protected int computeVerticalScrollExtent() {
11086 return getHeight();
11087 }
11088
11089 /**
Adam Powell69159442011-06-13 17:53:06 -070011090 * Check if this view can be scrolled horizontally in a certain direction.
11091 *
11092 * @param direction Negative to check scrolling left, positive to check scrolling right.
11093 * @return true if this view can be scrolled in the specified direction, false otherwise.
11094 */
11095 public boolean canScrollHorizontally(int direction) {
11096 final int offset = computeHorizontalScrollOffset();
11097 final int range = computeHorizontalScrollRange() - computeHorizontalScrollExtent();
11098 if (range == 0) return false;
11099 if (direction < 0) {
11100 return offset > 0;
11101 } else {
11102 return offset < range - 1;
11103 }
11104 }
11105
11106 /**
11107 * Check if this view can be scrolled vertically in a certain direction.
11108 *
11109 * @param direction Negative to check scrolling up, positive to check scrolling down.
11110 * @return true if this view can be scrolled in the specified direction, false otherwise.
11111 */
11112 public boolean canScrollVertically(int direction) {
11113 final int offset = computeVerticalScrollOffset();
11114 final int range = computeVerticalScrollRange() - computeVerticalScrollExtent();
11115 if (range == 0) return false;
11116 if (direction < 0) {
11117 return offset > 0;
11118 } else {
11119 return offset < range - 1;
11120 }
11121 }
11122
11123 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011124 * <p>Request the drawing of the horizontal and the vertical scrollbar. The
11125 * scrollbars are painted only if they have been awakened first.</p>
11126 *
11127 * @param canvas the canvas on which to draw the scrollbars
Joe Malin32736f02011-01-19 16:14:20 -080011128 *
Mike Cleronf116bf82009-09-27 19:14:12 -070011129 * @see #awakenScrollBars(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011130 */
Romain Guy1d5b3a62009-11-05 18:44:12 -080011131 protected final void onDrawScrollBars(Canvas canvas) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011132 // scrollbars are drawn only when the animation is running
11133 final ScrollabilityCache cache = mScrollCache;
11134 if (cache != null) {
Joe Malin32736f02011-01-19 16:14:20 -080011135
Mike Cleronf116bf82009-09-27 19:14:12 -070011136 int state = cache.state;
Joe Malin32736f02011-01-19 16:14:20 -080011137
Mike Cleronf116bf82009-09-27 19:14:12 -070011138 if (state == ScrollabilityCache.OFF) {
11139 return;
11140 }
Joe Malin32736f02011-01-19 16:14:20 -080011141
Mike Cleronf116bf82009-09-27 19:14:12 -070011142 boolean invalidate = false;
Joe Malin32736f02011-01-19 16:14:20 -080011143
Mike Cleronf116bf82009-09-27 19:14:12 -070011144 if (state == ScrollabilityCache.FADING) {
11145 // We're fading -- get our fade interpolation
11146 if (cache.interpolatorValues == null) {
11147 cache.interpolatorValues = new float[1];
11148 }
Joe Malin32736f02011-01-19 16:14:20 -080011149
Mike Cleronf116bf82009-09-27 19:14:12 -070011150 float[] values = cache.interpolatorValues;
Joe Malin32736f02011-01-19 16:14:20 -080011151
Mike Cleronf116bf82009-09-27 19:14:12 -070011152 // Stops the animation if we're done
11153 if (cache.scrollBarInterpolator.timeToValues(values) ==
11154 Interpolator.Result.FREEZE_END) {
11155 cache.state = ScrollabilityCache.OFF;
11156 } else {
11157 cache.scrollBar.setAlpha(Math.round(values[0]));
11158 }
Joe Malin32736f02011-01-19 16:14:20 -080011159
11160 // This will make the scroll bars inval themselves after
Mike Cleronf116bf82009-09-27 19:14:12 -070011161 // drawing. We only want this when we're fading so that
11162 // we prevent excessive redraws
11163 invalidate = true;
11164 } else {
11165 // We're just on -- but we may have been fading before so
11166 // reset alpha
11167 cache.scrollBar.setAlpha(255);
11168 }
11169
Joe Malin32736f02011-01-19 16:14:20 -080011170
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011171 final int viewFlags = mViewFlags;
11172
11173 final boolean drawHorizontalScrollBar =
11174 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
11175 final boolean drawVerticalScrollBar =
11176 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL
11177 && !isVerticalScrollBarHidden();
11178
11179 if (drawVerticalScrollBar || drawHorizontalScrollBar) {
11180 final int width = mRight - mLeft;
11181 final int height = mBottom - mTop;
11182
11183 final ScrollBarDrawable scrollBar = cache.scrollBar;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011184
Mike Reede8853fc2009-09-04 14:01:48 -040011185 final int scrollX = mScrollX;
11186 final int scrollY = mScrollY;
11187 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0;
11188
Mike Cleronf116bf82009-09-27 19:14:12 -070011189 int left, top, right, bottom;
Joe Malin32736f02011-01-19 16:14:20 -080011190
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011191 if (drawHorizontalScrollBar) {
Adam Powell3ba67742011-01-27 14:16:55 -080011192 int size = scrollBar.getSize(false);
11193 if (size <= 0) {
11194 size = cache.scrollBarSize;
11195 }
11196
Mike Cleronf116bf82009-09-27 19:14:12 -070011197 scrollBar.setParameters(computeHorizontalScrollRange(),
Mike Reede8853fc2009-09-04 14:01:48 -040011198 computeHorizontalScrollOffset(),
11199 computeHorizontalScrollExtent(), false);
Mike Reede8853fc2009-09-04 14:01:48 -040011200 final int verticalScrollBarGap = drawVerticalScrollBar ?
Mike Cleronf116bf82009-09-27 19:14:12 -070011201 getVerticalScrollbarWidth() : 0;
Joe Malin32736f02011-01-19 16:14:20 -080011202 top = scrollY + height - size - (mUserPaddingBottom & inside);
Mike Cleronf116bf82009-09-27 19:14:12 -070011203 left = scrollX + (mPaddingLeft & inside);
11204 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap;
11205 bottom = top + size;
11206 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom);
11207 if (invalidate) {
11208 invalidate(left, top, right, bottom);
11209 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011210 }
11211
11212 if (drawVerticalScrollBar) {
Adam Powell3ba67742011-01-27 14:16:55 -080011213 int size = scrollBar.getSize(true);
11214 if (size <= 0) {
11215 size = cache.scrollBarSize;
11216 }
11217
Mike Reede8853fc2009-09-04 14:01:48 -040011218 scrollBar.setParameters(computeVerticalScrollRange(),
11219 computeVerticalScrollOffset(),
11220 computeVerticalScrollExtent(), true);
Fabrice Di Meglioc91b6ca2012-06-22 14:51:15 -070011221 int verticalScrollbarPosition = mVerticalScrollbarPosition;
11222 if (verticalScrollbarPosition == SCROLLBAR_POSITION_DEFAULT) {
11223 verticalScrollbarPosition = isLayoutRtl() ?
11224 SCROLLBAR_POSITION_LEFT : SCROLLBAR_POSITION_RIGHT;
11225 }
11226 switch (verticalScrollbarPosition) {
Adam Powell20232d02010-12-08 21:08:53 -080011227 default:
Adam Powell20232d02010-12-08 21:08:53 -080011228 case SCROLLBAR_POSITION_RIGHT:
11229 left = scrollX + width - size - (mUserPaddingRight & inside);
11230 break;
11231 case SCROLLBAR_POSITION_LEFT:
11232 left = scrollX + (mUserPaddingLeft & inside);
11233 break;
11234 }
Mike Cleronf116bf82009-09-27 19:14:12 -070011235 top = scrollY + (mPaddingTop & inside);
11236 right = left + size;
11237 bottom = scrollY + height - (mUserPaddingBottom & inside);
11238 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom);
11239 if (invalidate) {
11240 invalidate(left, top, right, bottom);
11241 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011242 }
11243 }
11244 }
11245 }
Romain Guy8506ab42009-06-11 17:35:47 -070011246
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011247 /**
Romain Guy8506ab42009-06-11 17:35:47 -070011248 * 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 -080011249 * FastScroller is visible.
11250 * @return whether to temporarily hide the vertical scrollbar
11251 * @hide
11252 */
11253 protected boolean isVerticalScrollBarHidden() {
11254 return false;
11255 }
11256
11257 /**
11258 * <p>Draw the horizontal scrollbar if
11259 * {@link #isHorizontalScrollBarEnabled()} returns true.</p>
11260 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011261 * @param canvas the canvas on which to draw the scrollbar
11262 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011263 *
11264 * @see #isHorizontalScrollBarEnabled()
11265 * @see #computeHorizontalScrollRange()
11266 * @see #computeHorizontalScrollExtent()
11267 * @see #computeHorizontalScrollOffset()
11268 * @see android.widget.ScrollBarDrawable
Mike Cleronf116bf82009-09-27 19:14:12 -070011269 * @hide
Mike Reed4d6fe5f2009-09-03 13:29:05 -040011270 */
Romain Guy8fb95422010-08-17 18:38:51 -070011271 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar,
11272 int l, int t, int r, int b) {
Mike Reed4d6fe5f2009-09-03 13:29:05 -040011273 scrollBar.setBounds(l, t, r, b);
Mike Reed4d6fe5f2009-09-03 13:29:05 -040011274 scrollBar.draw(canvas);
11275 }
Mike Reede8853fc2009-09-04 14:01:48 -040011276
Mike Reed4d6fe5f2009-09-03 13:29:05 -040011277 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011278 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()}
11279 * returns true.</p>
11280 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011281 * @param canvas the canvas on which to draw the scrollbar
11282 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011283 *
11284 * @see #isVerticalScrollBarEnabled()
11285 * @see #computeVerticalScrollRange()
11286 * @see #computeVerticalScrollExtent()
11287 * @see #computeVerticalScrollOffset()
11288 * @see android.widget.ScrollBarDrawable
Mike Reede8853fc2009-09-04 14:01:48 -040011289 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011290 */
Romain Guy8fb95422010-08-17 18:38:51 -070011291 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar,
11292 int l, int t, int r, int b) {
Mike Reede8853fc2009-09-04 14:01:48 -040011293 scrollBar.setBounds(l, t, r, b);
11294 scrollBar.draw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011295 }
11296
11297 /**
11298 * Implement this to do your drawing.
11299 *
11300 * @param canvas the canvas on which the background will be drawn
11301 */
11302 protected void onDraw(Canvas canvas) {
11303 }
11304
11305 /*
11306 * Caller is responsible for calling requestLayout if necessary.
11307 * (This allows addViewInLayout to not request a new layout.)
11308 */
11309 void assignParent(ViewParent parent) {
11310 if (mParent == null) {
11311 mParent = parent;
11312 } else if (parent == null) {
11313 mParent = null;
11314 } else {
11315 throw new RuntimeException("view " + this + " being added, but"
11316 + " it already has a parent");
11317 }
11318 }
11319
11320 /**
11321 * This is called when the view is attached to a window. At this point it
11322 * has a Surface and will start drawing. Note that this function is
Romain Guy5c22a8c2011-05-13 11:48:45 -070011323 * guaranteed to be called before {@link #onDraw(android.graphics.Canvas)},
11324 * however it may be called any time before the first onDraw -- including
11325 * before or after {@link #onMeasure(int, int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011326 *
11327 * @see #onDetachedFromWindow()
11328 */
11329 protected void onAttachedToWindow() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070011330 if ((mPrivateFlags & PFLAG_REQUEST_TRANSPARENT_REGIONS) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011331 mParent.requestTransparentRegion(this);
11332 }
Romain Guy2a0f2282012-05-08 14:43:12 -070011333
Dianne Hackborn4702a852012-08-17 15:18:29 -070011334 if ((mPrivateFlags & PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) {
Adam Powell8568c3a2010-04-19 14:26:11 -070011335 initialAwakenScrollBars();
Dianne Hackborn4702a852012-08-17 15:18:29 -070011336 mPrivateFlags &= ~PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH;
Adam Powell8568c3a2010-04-19 14:26:11 -070011337 }
Romain Guy2a0f2282012-05-08 14:43:12 -070011338
Chet Haasea9b61ac2010-12-20 07:40:25 -080011339 jumpDrawablesToCurrentState();
Romain Guy2a0f2282012-05-08 14:43:12 -070011340
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -070011341 resolveRtlProperties();
Romain Guy2a0f2282012-05-08 14:43:12 -070011342
Svetoslav Ganov42138042012-03-20 11:51:39 -070011343 clearAccessibilityFocus();
Amith Yamasani4503c8d2011-06-17 12:36:14 -070011344 if (isFocused()) {
11345 InputMethodManager imm = InputMethodManager.peekInstance();
11346 imm.focusIn(this);
11347 }
Romain Guy2a0f2282012-05-08 14:43:12 -070011348
11349 if (mAttachInfo != null && mDisplayList != null) {
11350 mAttachInfo.mViewRootImpl.dequeueDisplayList(mDisplayList);
11351 }
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -070011352 }
Cibu Johny86666632010-02-22 13:01:02 -080011353
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -070011354 void resolveRtlProperties() {
11355 // Order is important here: LayoutDirection MUST be resolved first...
11356 resolveLayoutDirection();
11357 // ... then we can resolve the others properties depending on the resolved LayoutDirection.
11358 resolvePadding();
11359 resolveLayoutParams();
11360 resolveTextDirection();
11361 resolveTextAlignment();
11362 }
11363
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -070011364 /**
Romain Guybb9908b2012-03-08 11:14:07 -080011365 * @see #onScreenStateChanged(int)
11366 */
11367 void dispatchScreenStateChanged(int screenState) {
11368 onScreenStateChanged(screenState);
11369 }
11370
11371 /**
11372 * This method is called whenever the state of the screen this view is
11373 * attached to changes. A state change will usually occurs when the screen
11374 * turns on or off (whether it happens automatically or the user does it
11375 * manually.)
11376 *
11377 * @param screenState The new state of the screen. Can be either
11378 * {@link #SCREEN_STATE_ON} or {@link #SCREEN_STATE_OFF}
11379 */
11380 public void onScreenStateChanged(int screenState) {
11381 }
11382
11383 /**
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011384 * Return true if the application tag in the AndroidManifest has set "supportRtl" to true
11385 */
11386 private boolean hasRtlSupport() {
11387 return mContext.getApplicationInfo().hasRtlSupport();
11388 }
11389
11390 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011391 * Resolve and cache the layout direction. LTR is set initially. This is implicitly supposing
11392 * that the parent directionality can and will be resolved before its children.
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011393 * Will call {@link View#onResolvedLayoutDirectionChanged} when resolution is done.
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -070011394 */
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011395 public void resolveLayoutDirection() {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011396 // Clear any previous layout direction resolution
Dianne Hackborn4702a852012-08-17 15:18:29 -070011397 mPrivateFlags2 &= ~PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011398
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011399 if (hasRtlSupport()) {
11400 // Set resolved depending on layout direction
11401 switch (getLayoutDirection()) {
11402 case LAYOUT_DIRECTION_INHERIT:
Fabrice Di Megliob93911f2012-06-26 19:43:15 -070011403 // We cannot resolve yet. LTR is by default and let the resolution happen again
11404 // later to get the correct resolved value
11405 if (!canResolveLayoutDirection()) return;
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011406
Fabrice Di Megliob93911f2012-06-26 19:43:15 -070011407 ViewGroup viewGroup = ((ViewGroup) mParent);
11408
11409 // We cannot resolve yet on the parent too. LTR is by default and let the
11410 // resolution happen again later
11411 if (!viewGroup.canResolveLayoutDirection()) return;
11412
11413 if (viewGroup.getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070011414 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL;
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011415 }
11416 break;
11417 case LAYOUT_DIRECTION_RTL:
Dianne Hackborn4702a852012-08-17 15:18:29 -070011418 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL;
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011419 break;
11420 case LAYOUT_DIRECTION_LOCALE:
11421 if(isLayoutDirectionRtl(Locale.getDefault())) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070011422 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL;
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011423 }
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011424 break;
11425 default:
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011426 // Nothing to do, LTR by default
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011427 }
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011428 }
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011429
11430 // Set to resolved
Dianne Hackborn4702a852012-08-17 15:18:29 -070011431 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED;
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011432 onResolvedLayoutDirectionChanged();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011433 }
11434
Fabrice Di Meglioaff599b2011-07-20 19:05:01 -070011435 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011436 * Called when layout direction has been resolved.
11437 *
11438 * The default implementation does nothing.
11439 */
11440 public void onResolvedLayoutDirectionChanged() {
11441 }
11442
11443 /**
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -070011444 * Return if padding has been resolved
11445 */
11446 boolean isPaddingResolved() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070011447 return (mPrivateFlags2 & PFLAG2_PADDING_RESOLVED) != 0;
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -070011448 }
11449
11450 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011451 * Resolve padding depending on layout direction.
Fabrice Di Meglioaff599b2011-07-20 19:05:01 -070011452 */
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011453 public void resolvePadding() {
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -070011454 final int targetSdkVersion = getContext().getApplicationInfo().targetSdkVersion;
11455 if (targetSdkVersion < JELLY_BEAN_MR1 || !hasRtlSupport()) {
11456 // Pre Jelly Bean MR1 case (compatibility mode) OR no RTL support case:
11457 // left / right padding are used if defined. If they are not defined and start / end
11458 // padding are defined (e.g. in Frameworks resources), then we use start / end and
11459 // resolve them as left / right (layout direction is not taken into account).
11460 if (!mUserPaddingLeftDefined && mUserPaddingStart != UNDEFINED_PADDING) {
11461 mUserPaddingLeft = mUserPaddingStart;
11462 }
11463 if (!mUserPaddingRightDefined && mUserPaddingEnd != UNDEFINED_PADDING) {
11464 mUserPaddingRight = mUserPaddingEnd;
11465 }
11466
11467 mUserPaddingBottom = (mUserPaddingBottom >= 0) ? mUserPaddingBottom : mPaddingBottom;
11468
11469 internalSetPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight,
11470 mUserPaddingBottom);
11471 } else {
11472 // Post Jelly Bean MR1 case: we need to take the resolved layout direction into account.
11473 // If start / end padding are defined, they will be resolved (hence overriding) to
11474 // left / right or right / left depending on the resolved layout direction.
11475 // If start / end padding are not defined, use the left / right ones.
11476 int resolvedLayoutDirection = getResolvedLayoutDirection();
11477 switch (resolvedLayoutDirection) {
11478 case LAYOUT_DIRECTION_RTL:
11479 if (mUserPaddingStart != UNDEFINED_PADDING) {
11480 mUserPaddingRight = mUserPaddingStart;
11481 }
11482 if (mUserPaddingEnd != UNDEFINED_PADDING) {
11483 mUserPaddingLeft = mUserPaddingEnd;
11484 }
11485 break;
11486 case LAYOUT_DIRECTION_LTR:
11487 default:
11488 if (mUserPaddingStart != UNDEFINED_PADDING) {
11489 mUserPaddingLeft = mUserPaddingStart;
11490 }
11491 if (mUserPaddingEnd != UNDEFINED_PADDING) {
11492 mUserPaddingRight = mUserPaddingEnd;
11493 }
11494 }
11495
11496 mUserPaddingBottom = (mUserPaddingBottom >= 0) ? mUserPaddingBottom : mPaddingBottom;
11497
11498 internalSetPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight,
11499 mUserPaddingBottom);
11500 onPaddingChanged(resolvedLayoutDirection);
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011501 }
11502
Dianne Hackborn4702a852012-08-17 15:18:29 -070011503 mPrivateFlags2 |= PFLAG2_PADDING_RESOLVED;
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011504 }
11505
11506 /**
11507 * Resolve padding depending on the layout direction. Subclasses that care about
11508 * padding resolution should override this method. The default implementation does
11509 * nothing.
11510 *
11511 * @param layoutDirection the direction of the layout
11512 *
Fabrice Di Meglioe8dc07d2012-03-09 17:10:19 -080011513 * @see {@link #LAYOUT_DIRECTION_LTR}
11514 * @see {@link #LAYOUT_DIRECTION_RTL}
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011515 */
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011516 public void onPaddingChanged(int layoutDirection) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011517 }
11518
Fabrice Di Meglio2273b1e2011-09-07 15:17:40 -070011519 /**
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011520 * Check if layout direction resolution can be done.
Fabrice Di Meglio2273b1e2011-09-07 15:17:40 -070011521 *
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011522 * @return true if layout direction resolution can be done otherwise return false.
Fabrice Di Meglio2273b1e2011-09-07 15:17:40 -070011523 */
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011524 public boolean canResolveLayoutDirection() {
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011525 switch (getLayoutDirection()) {
11526 case LAYOUT_DIRECTION_INHERIT:
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011527 return (mParent != null) && (mParent instanceof ViewGroup);
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011528 default:
11529 return true;
11530 }
11531 }
11532
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011533 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011534 * Reset the resolved layout direction. Will call {@link View#onResolvedLayoutDirectionReset}
11535 * when reset is done.
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011536 */
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011537 public void resetResolvedLayoutDirection() {
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -070011538 // Reset the current resolved bits
Dianne Hackborn4702a852012-08-17 15:18:29 -070011539 mPrivateFlags2 &= ~PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK;
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011540 onResolvedLayoutDirectionReset();
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080011541 // Reset also the text direction
11542 resetResolvedTextDirection();
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011543 }
11544
11545 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011546 * Called during reset of resolved layout direction.
11547 *
11548 * Subclasses need to override this method to clear cached information that depends on the
11549 * resolved layout direction, or to inform child views that inherit their layout direction.
11550 *
11551 * The default implementation does nothing.
11552 */
11553 public void onResolvedLayoutDirectionReset() {
11554 }
11555
11556 /**
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011557 * Check if a Locale uses an RTL script.
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011558 *
11559 * @param locale Locale to check
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011560 * @return true if the Locale uses an RTL script.
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011561 */
Fabrice Di Meglio22268862011-06-27 18:13:18 -070011562 protected static boolean isLayoutDirectionRtl(Locale locale) {
Fabrice Di Meglio3fb824b2012-02-28 17:58:31 -080011563 return (LAYOUT_DIRECTION_RTL == LocaleUtil.getLayoutDirectionFromLocale(locale));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011564 }
11565
11566 /**
11567 * This is called when the view is detached from a window. At this point it
11568 * no longer has a surface for drawing.
11569 *
11570 * @see #onAttachedToWindow()
11571 */
11572 protected void onDetachedFromWindow() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070011573 mPrivateFlags &= ~PFLAG_CANCEL_NEXT_UP_EVENT;
Romain Guy6c319ca2011-01-11 14:29:25 -080011574
Romain Guya440b002010-02-24 15:57:54 -080011575 removeUnsetPressCallback();
Maryam Garrett1549dd12009-12-15 16:06:36 -050011576 removeLongPressCallback();
Adam Powell3cb8b632011-01-21 15:34:14 -080011577 removePerformClickCallback();
Svetoslav Ganova0156172011-06-26 17:55:44 -070011578 removeSendViewScrolledAccessibilityEventCallback();
Romain Guy6c319ca2011-01-11 14:29:25 -080011579
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011580 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -080011581
Romain Guya998dff2012-03-23 18:58:36 -070011582 destroyLayer(false);
Romain Guy8dd5b1e2011-01-14 17:28:51 -080011583
11584 if (mAttachInfo != null) {
Romain Guy51e4d4d2012-03-15 18:30:47 -070011585 if (mDisplayList != null) {
Romain Guy2a0f2282012-05-08 14:43:12 -070011586 mAttachInfo.mViewRootImpl.enqueueDisplayList(mDisplayList);
Romain Guy51e4d4d2012-03-15 18:30:47 -070011587 }
Jeff Browna175a5b2012-02-15 19:18:31 -080011588 mAttachInfo.mViewRootImpl.cancelInvalidate(this);
Romain Guy51e4d4d2012-03-15 18:30:47 -070011589 } else {
Romain Guy38c2ece2012-05-24 14:20:56 -070011590 // Should never happen
11591 clearDisplayList();
Romain Guy8dd5b1e2011-01-14 17:28:51 -080011592 }
11593
Patrick Dubroyec84c3a2011-01-13 17:55:37 -080011594 mCurrentAnimation = null;
Fabrice Di Meglio7f86c802011-07-01 15:09:24 -070011595
11596 resetResolvedLayoutDirection();
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070011597 resetResolvedTextAlignment();
Svetoslav Ganov42138042012-03-20 11:51:39 -070011598 resetAccessibilityStateChanged();
Dianne Hackborn4702a852012-08-17 15:18:29 -070011599 mPrivateFlags2 &= ~PFLAG2_PADDING_RESOLVED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011600 }
11601
11602 /**
11603 * @return The number of times this view has been attached to a window
11604 */
11605 protected int getWindowAttachCount() {
11606 return mWindowAttachCount;
11607 }
11608
11609 /**
11610 * Retrieve a unique token identifying the window this view is attached to.
11611 * @return Return the window's token for use in
11612 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}.
11613 */
11614 public IBinder getWindowToken() {
11615 return mAttachInfo != null ? mAttachInfo.mWindowToken : null;
11616 }
11617
11618 /**
11619 * Retrieve a unique token identifying the top-level "real" window of
11620 * the window that this view is attached to. That is, this is like
11621 * {@link #getWindowToken}, except if the window this view in is a panel
11622 * window (attached to another containing window), then the token of
11623 * the containing window is returned instead.
11624 *
11625 * @return Returns the associated window token, either
11626 * {@link #getWindowToken()} or the containing window's token.
11627 */
11628 public IBinder getApplicationWindowToken() {
11629 AttachInfo ai = mAttachInfo;
11630 if (ai != null) {
11631 IBinder appWindowToken = ai.mPanelParentWindowToken;
11632 if (appWindowToken == null) {
11633 appWindowToken = ai.mWindowToken;
11634 }
11635 return appWindowToken;
11636 }
11637 return null;
11638 }
11639
11640 /**
Jeff Brown98365d72012-08-19 20:30:52 -070011641 * Gets the logical display to which the view's window has been attached.
11642 *
11643 * @return The logical display, or null if the view is not currently attached to a window.
11644 */
11645 public Display getDisplay() {
11646 return mAttachInfo != null ? mAttachInfo.mDisplay : null;
11647 }
11648
11649 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011650 * Retrieve private session object this view hierarchy is using to
11651 * communicate with the window manager.
11652 * @return the session object to communicate with the window manager
11653 */
11654 /*package*/ IWindowSession getWindowSession() {
11655 return mAttachInfo != null ? mAttachInfo.mSession : null;
11656 }
11657
11658 /**
11659 * @param info the {@link android.view.View.AttachInfo} to associated with
11660 * this view
11661 */
11662 void dispatchAttachedToWindow(AttachInfo info, int visibility) {
11663 //System.out.println("Attached! " + this);
11664 mAttachInfo = info;
11665 mWindowAttachCount++;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080011666 // We will need to evaluate the drawable state at least once.
Dianne Hackborn4702a852012-08-17 15:18:29 -070011667 mPrivateFlags |= PFLAG_DRAWABLE_STATE_DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011668 if (mFloatingTreeObserver != null) {
11669 info.mTreeObserver.merge(mFloatingTreeObserver);
11670 mFloatingTreeObserver = null;
11671 }
Dianne Hackborn4702a852012-08-17 15:18:29 -070011672 if ((mPrivateFlags&PFLAG_SCROLL_CONTAINER) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011673 mAttachInfo.mScrollContainers.add(this);
Dianne Hackborn4702a852012-08-17 15:18:29 -070011674 mPrivateFlags |= PFLAG_SCROLL_CONTAINER_ADDED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011675 }
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -070011676 performCollectViewAttributes(mAttachInfo, visibility);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011677 onAttachedToWindow();
Adam Powell4afd62b2011-02-18 15:02:18 -080011678
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011679 ListenerInfo li = mListenerInfo;
Adam Powell4afd62b2011-02-18 15:02:18 -080011680 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners =
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011681 li != null ? li.mOnAttachStateChangeListeners : null;
Adam Powell4afd62b2011-02-18 15:02:18 -080011682 if (listeners != null && listeners.size() > 0) {
11683 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to
11684 // perform the dispatching. The iterator is a safe guard against listeners that
11685 // could mutate the list by calling the various add/remove methods. This prevents
11686 // the array from being modified while we iterate it.
11687 for (OnAttachStateChangeListener listener : listeners) {
11688 listener.onViewAttachedToWindow(this);
11689 }
11690 }
11691
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011692 int vis = info.mWindowVisibility;
11693 if (vis != GONE) {
11694 onWindowVisibilityChanged(vis);
11695 }
Dianne Hackborn4702a852012-08-17 15:18:29 -070011696 if ((mPrivateFlags&PFLAG_DRAWABLE_STATE_DIRTY) != 0) {
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080011697 // If nobody has evaluated the drawable state yet, then do it now.
11698 refreshDrawableState();
11699 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011700 }
11701
11702 void dispatchDetachedFromWindow() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011703 AttachInfo info = mAttachInfo;
11704 if (info != null) {
11705 int vis = info.mWindowVisibility;
11706 if (vis != GONE) {
11707 onWindowVisibilityChanged(GONE);
11708 }
11709 }
11710
11711 onDetachedFromWindow();
Romain Guy01d5edc2011-01-28 11:28:53 -080011712
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011713 ListenerInfo li = mListenerInfo;
Adam Powell4afd62b2011-02-18 15:02:18 -080011714 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners =
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011715 li != null ? li.mOnAttachStateChangeListeners : null;
Adam Powell4afd62b2011-02-18 15:02:18 -080011716 if (listeners != null && listeners.size() > 0) {
11717 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to
11718 // perform the dispatching. The iterator is a safe guard against listeners that
11719 // could mutate the list by calling the various add/remove methods. This prevents
11720 // the array from being modified while we iterate it.
11721 for (OnAttachStateChangeListener listener : listeners) {
11722 listener.onViewDetachedFromWindow(this);
11723 }
11724 }
11725
Dianne Hackborn4702a852012-08-17 15:18:29 -070011726 if ((mPrivateFlags & PFLAG_SCROLL_CONTAINER_ADDED) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011727 mAttachInfo.mScrollContainers.remove(this);
Dianne Hackborn4702a852012-08-17 15:18:29 -070011728 mPrivateFlags &= ~PFLAG_SCROLL_CONTAINER_ADDED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011729 }
Romain Guy01d5edc2011-01-28 11:28:53 -080011730
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011731 mAttachInfo = null;
11732 }
11733
11734 /**
11735 * Store this view hierarchy's frozen state into the given container.
11736 *
11737 * @param container The SparseArray in which to save the view's state.
11738 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011739 * @see #restoreHierarchyState(android.util.SparseArray)
11740 * @see #dispatchSaveInstanceState(android.util.SparseArray)
11741 * @see #onSaveInstanceState()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011742 */
11743 public void saveHierarchyState(SparseArray<Parcelable> container) {
11744 dispatchSaveInstanceState(container);
11745 }
11746
11747 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -070011748 * Called by {@link #saveHierarchyState(android.util.SparseArray)} to store the state for
11749 * this view and its children. May be overridden to modify how freezing happens to a
11750 * 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 -080011751 *
11752 * @param container The SparseArray in which to save the view's state.
11753 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011754 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
11755 * @see #saveHierarchyState(android.util.SparseArray)
11756 * @see #onSaveInstanceState()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011757 */
11758 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) {
11759 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070011760 mPrivateFlags &= ~PFLAG_SAVE_STATE_CALLED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011761 Parcelable state = onSaveInstanceState();
Dianne Hackborn4702a852012-08-17 15:18:29 -070011762 if ((mPrivateFlags & PFLAG_SAVE_STATE_CALLED) == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011763 throw new IllegalStateException(
11764 "Derived class did not call super.onSaveInstanceState()");
11765 }
11766 if (state != null) {
11767 // Log.i("View", "Freezing #" + Integer.toHexString(mID)
11768 // + ": " + state);
11769 container.put(mID, state);
11770 }
11771 }
11772 }
11773
11774 /**
11775 * Hook allowing a view to generate a representation of its internal state
11776 * that can later be used to create a new instance with that same state.
11777 * This state should only contain information that is not persistent or can
11778 * not be reconstructed later. For example, you will never store your
11779 * current position on screen because that will be computed again when a
11780 * new instance of the view is placed in its view hierarchy.
11781 * <p>
11782 * Some examples of things you may store here: the current cursor position
11783 * in a text view (but usually not the text itself since that is stored in a
11784 * content provider or other persistent storage), the currently selected
11785 * item in a list view.
11786 *
11787 * @return Returns a Parcelable object containing the view's current dynamic
11788 * state, or null if there is nothing interesting to save. The
11789 * default implementation returns null.
Philip Milne6c8ea062012-04-03 17:38:43 -070011790 * @see #onRestoreInstanceState(android.os.Parcelable)
11791 * @see #saveHierarchyState(android.util.SparseArray)
11792 * @see #dispatchSaveInstanceState(android.util.SparseArray)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011793 * @see #setSaveEnabled(boolean)
11794 */
11795 protected Parcelable onSaveInstanceState() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070011796 mPrivateFlags |= PFLAG_SAVE_STATE_CALLED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011797 return BaseSavedState.EMPTY_STATE;
11798 }
11799
11800 /**
11801 * Restore this view hierarchy's frozen state from the given container.
11802 *
11803 * @param container The SparseArray which holds previously frozen states.
11804 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011805 * @see #saveHierarchyState(android.util.SparseArray)
11806 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
11807 * @see #onRestoreInstanceState(android.os.Parcelable)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011808 */
11809 public void restoreHierarchyState(SparseArray<Parcelable> container) {
11810 dispatchRestoreInstanceState(container);
11811 }
11812
11813 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -070011814 * Called by {@link #restoreHierarchyState(android.util.SparseArray)} to retrieve the
11815 * state for this view and its children. May be overridden to modify how restoring
11816 * happens to a view's children; for example, some views may want to not store state
11817 * for their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011818 *
11819 * @param container The SparseArray which holds previously saved state.
11820 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011821 * @see #dispatchSaveInstanceState(android.util.SparseArray)
11822 * @see #restoreHierarchyState(android.util.SparseArray)
11823 * @see #onRestoreInstanceState(android.os.Parcelable)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011824 */
11825 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) {
11826 if (mID != NO_ID) {
11827 Parcelable state = container.get(mID);
11828 if (state != null) {
11829 // Log.i("View", "Restoreing #" + Integer.toHexString(mID)
11830 // + ": " + state);
Dianne Hackborn4702a852012-08-17 15:18:29 -070011831 mPrivateFlags &= ~PFLAG_SAVE_STATE_CALLED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011832 onRestoreInstanceState(state);
Dianne Hackborn4702a852012-08-17 15:18:29 -070011833 if ((mPrivateFlags & PFLAG_SAVE_STATE_CALLED) == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011834 throw new IllegalStateException(
11835 "Derived class did not call super.onRestoreInstanceState()");
11836 }
11837 }
11838 }
11839 }
11840
11841 /**
11842 * Hook allowing a view to re-apply a representation of its internal state that had previously
11843 * been generated by {@link #onSaveInstanceState}. This function will never be called with a
11844 * null state.
11845 *
11846 * @param state The frozen state that had previously been returned by
11847 * {@link #onSaveInstanceState}.
11848 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011849 * @see #onSaveInstanceState()
11850 * @see #restoreHierarchyState(android.util.SparseArray)
11851 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011852 */
11853 protected void onRestoreInstanceState(Parcelable state) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070011854 mPrivateFlags |= PFLAG_SAVE_STATE_CALLED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011855 if (state != BaseSavedState.EMPTY_STATE && state != null) {
Romain Guy237c1ce2009-12-08 11:30:25 -080011856 throw new IllegalArgumentException("Wrong state class, expecting View State but "
11857 + "received " + state.getClass().toString() + " instead. This usually happens "
Joe Malin32736f02011-01-19 16:14:20 -080011858 + "when two views of different type have the same id in the same hierarchy. "
11859 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure "
Romain Guy237c1ce2009-12-08 11:30:25 -080011860 + "other views do not use the same id.");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011861 }
11862 }
11863
11864 /**
11865 * <p>Return the time at which the drawing of the view hierarchy started.</p>
11866 *
11867 * @return the drawing start time in milliseconds
11868 */
11869 public long getDrawingTime() {
11870 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0;
11871 }
11872
11873 /**
11874 * <p>Enables or disables the duplication of the parent's state into this view. When
11875 * duplication is enabled, this view gets its drawable state from its parent rather
11876 * than from its own internal properties.</p>
11877 *
11878 * <p>Note: in the current implementation, setting this property to true after the
11879 * view was added to a ViewGroup might have no effect at all. This property should
11880 * always be used from XML or set to true before adding this view to a ViewGroup.</p>
11881 *
11882 * <p>Note: if this view's parent addStateFromChildren property is enabled and this
11883 * property is enabled, an exception will be thrown.</p>
Joe Malin32736f02011-01-19 16:14:20 -080011884 *
Gilles Debunnefb817032011-01-13 13:52:49 -080011885 * <p>Note: if the child view uses and updates additionnal states which are unknown to the
11886 * parent, these states should not be affected by this method.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011887 *
11888 * @param enabled True to enable duplication of the parent's drawable state, false
11889 * to disable it.
11890 *
11891 * @see #getDrawableState()
11892 * @see #isDuplicateParentStateEnabled()
11893 */
11894 public void setDuplicateParentStateEnabled(boolean enabled) {
11895 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE);
11896 }
11897
11898 /**
11899 * <p>Indicates whether this duplicates its drawable state from its parent.</p>
11900 *
11901 * @return True if this view's drawable state is duplicated from the parent,
11902 * false otherwise
11903 *
11904 * @see #getDrawableState()
11905 * @see #setDuplicateParentStateEnabled(boolean)
11906 */
11907 public boolean isDuplicateParentStateEnabled() {
11908 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE;
11909 }
11910
11911 /**
Romain Guy171c5922011-01-06 10:04:23 -080011912 * <p>Specifies the type of layer backing this view. The layer can be
11913 * {@link #LAYER_TYPE_NONE disabled}, {@link #LAYER_TYPE_SOFTWARE software} or
11914 * {@link #LAYER_TYPE_HARDWARE hardware}.</p>
Joe Malin32736f02011-01-19 16:14:20 -080011915 *
Romain Guy171c5922011-01-06 10:04:23 -080011916 * <p>A layer is associated with an optional {@link android.graphics.Paint}
11917 * instance that controls how the layer is composed on screen. The following
11918 * properties of the paint are taken into account when composing the layer:</p>
11919 * <ul>
11920 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li>
11921 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li>
11922 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li>
11923 * </ul>
Joe Malin32736f02011-01-19 16:14:20 -080011924 *
Romain Guy171c5922011-01-06 10:04:23 -080011925 * <p>If this view has an alpha value set to < 1.0 by calling
11926 * {@link #setAlpha(float)}, the alpha value of the layer's paint is replaced by
11927 * this view's alpha value. Calling {@link #setAlpha(float)} is therefore
11928 * equivalent to setting a hardware layer on this view and providing a paint with
11929 * the desired alpha value.<p>
Joe Malin32736f02011-01-19 16:14:20 -080011930 *
Romain Guy171c5922011-01-06 10:04:23 -080011931 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE disabled},
11932 * {@link #LAYER_TYPE_SOFTWARE software} and {@link #LAYER_TYPE_HARDWARE hardware}
11933 * for more information on when and how to use layers.</p>
Joe Malin32736f02011-01-19 16:14:20 -080011934 *
Romain Guy171c5922011-01-06 10:04:23 -080011935 * @param layerType The ype of layer to use with this view, must be one of
11936 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
11937 * {@link #LAYER_TYPE_HARDWARE}
11938 * @param paint The paint used to compose the layer. This argument is optional
11939 * and can be null. It is ignored when the layer type is
11940 * {@link #LAYER_TYPE_NONE}
Joe Malin32736f02011-01-19 16:14:20 -080011941 *
11942 * @see #getLayerType()
Romain Guy171c5922011-01-06 10:04:23 -080011943 * @see #LAYER_TYPE_NONE
11944 * @see #LAYER_TYPE_SOFTWARE
11945 * @see #LAYER_TYPE_HARDWARE
Joe Malin32736f02011-01-19 16:14:20 -080011946 * @see #setAlpha(float)
11947 *
Romain Guy171c5922011-01-06 10:04:23 -080011948 * @attr ref android.R.styleable#View_layerType
11949 */
11950 public void setLayerType(int layerType, Paint paint) {
11951 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) {
Joe Malin32736f02011-01-19 16:14:20 -080011952 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, "
Romain Guy171c5922011-01-06 10:04:23 -080011953 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE");
11954 }
Chet Haasedaf98e92011-01-10 14:10:36 -080011955
Romain Guyd6cd5722011-01-17 14:42:41 -080011956 if (layerType == mLayerType) {
11957 if (layerType != LAYER_TYPE_NONE && paint != mLayerPaint) {
11958 mLayerPaint = paint == null ? new Paint() : paint;
Romain Guy0fd89bf2011-01-26 15:41:30 -080011959 invalidateParentCaches();
11960 invalidate(true);
Romain Guyd6cd5722011-01-17 14:42:41 -080011961 }
11962 return;
11963 }
Romain Guy171c5922011-01-06 10:04:23 -080011964
11965 // Destroy any previous software drawing cache if needed
Romain Guy6c319ca2011-01-11 14:29:25 -080011966 switch (mLayerType) {
Chet Haase6f33e812011-05-17 12:42:19 -070011967 case LAYER_TYPE_HARDWARE:
Romain Guya998dff2012-03-23 18:58:36 -070011968 destroyLayer(false);
Romain Guy31f2c2e2011-11-21 10:55:41 -080011969 // fall through - non-accelerated views may use software layer mechanism instead
Romain Guy6c319ca2011-01-11 14:29:25 -080011970 case LAYER_TYPE_SOFTWARE:
Romain Guy6d7475d2011-07-27 16:28:21 -070011971 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -080011972 break;
Romain Guy6c319ca2011-01-11 14:29:25 -080011973 default:
11974 break;
Romain Guy171c5922011-01-06 10:04:23 -080011975 }
11976
11977 mLayerType = layerType;
Romain Guy3a3133d2011-02-01 22:59:58 -080011978 final boolean layerDisabled = mLayerType == LAYER_TYPE_NONE;
11979 mLayerPaint = layerDisabled ? null : (paint == null ? new Paint() : paint);
11980 mLocalDirtyRect = layerDisabled ? null : new Rect();
Romain Guy171c5922011-01-06 10:04:23 -080011981
Romain Guy0fd89bf2011-01-26 15:41:30 -080011982 invalidateParentCaches();
11983 invalidate(true);
Romain Guy171c5922011-01-06 10:04:23 -080011984 }
11985
11986 /**
Romain Guy59c7f802011-09-29 17:21:45 -070011987 * Indicates whether this view has a static layer. A view with layer type
11988 * {@link #LAYER_TYPE_NONE} is a static layer. Other types of layers are
11989 * dynamic.
11990 */
11991 boolean hasStaticLayer() {
Romain Guy2bf68f02012-03-02 13:37:47 -080011992 return true;
Romain Guy59c7f802011-09-29 17:21:45 -070011993 }
11994
11995 /**
Romain Guy171c5922011-01-06 10:04:23 -080011996 * Indicates what type of layer is currently associated with this view. By default
11997 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}.
11998 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)}
11999 * for more information on the different types of layers.
Joe Malin32736f02011-01-19 16:14:20 -080012000 *
Romain Guy171c5922011-01-06 10:04:23 -080012001 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
12002 * {@link #LAYER_TYPE_HARDWARE}
Joe Malin32736f02011-01-19 16:14:20 -080012003 *
12004 * @see #setLayerType(int, android.graphics.Paint)
Philip Milne6c8ea062012-04-03 17:38:43 -070012005 * @see #buildLayer()
Romain Guy171c5922011-01-06 10:04:23 -080012006 * @see #LAYER_TYPE_NONE
12007 * @see #LAYER_TYPE_SOFTWARE
12008 * @see #LAYER_TYPE_HARDWARE
12009 */
12010 public int getLayerType() {
12011 return mLayerType;
12012 }
Joe Malin32736f02011-01-19 16:14:20 -080012013
Romain Guy6c319ca2011-01-11 14:29:25 -080012014 /**
Romain Guyf1ae1062011-03-02 18:16:04 -080012015 * Forces this view's layer to be created and this view to be rendered
12016 * into its layer. If this view's layer type is set to {@link #LAYER_TYPE_NONE},
12017 * invoking this method will have no effect.
Philip Milne6c8ea062012-04-03 17:38:43 -070012018 *
Romain Guyf1ae1062011-03-02 18:16:04 -080012019 * This method can for instance be used to render a view into its layer before
12020 * starting an animation. If this view is complex, rendering into the layer
12021 * before starting the animation will avoid skipping frames.
Philip Milne6c8ea062012-04-03 17:38:43 -070012022 *
Romain Guyf1ae1062011-03-02 18:16:04 -080012023 * @throws IllegalStateException If this view is not attached to a window
Philip Milne6c8ea062012-04-03 17:38:43 -070012024 *
12025 * @see #setLayerType(int, android.graphics.Paint)
Romain Guyf1ae1062011-03-02 18:16:04 -080012026 */
12027 public void buildLayer() {
12028 if (mLayerType == LAYER_TYPE_NONE) return;
12029
12030 if (mAttachInfo == null) {
12031 throw new IllegalStateException("This view must be attached to a window first");
12032 }
12033
12034 switch (mLayerType) {
12035 case LAYER_TYPE_HARDWARE:
Romain Guyd0609e42011-11-21 17:21:15 -080012036 if (mAttachInfo.mHardwareRenderer != null &&
12037 mAttachInfo.mHardwareRenderer.isEnabled() &&
12038 mAttachInfo.mHardwareRenderer.validate()) {
Michael Jurka7e52caf2012-03-06 15:57:06 -080012039 getHardwareLayer();
Romain Guyd0609e42011-11-21 17:21:15 -080012040 }
Romain Guyf1ae1062011-03-02 18:16:04 -080012041 break;
12042 case LAYER_TYPE_SOFTWARE:
12043 buildDrawingCache(true);
12044 break;
12045 }
12046 }
Philip Milne6c8ea062012-04-03 17:38:43 -070012047
Romain Guyf1ae1062011-03-02 18:16:04 -080012048 /**
Romain Guy6c319ca2011-01-11 14:29:25 -080012049 * <p>Returns a hardware layer that can be used to draw this view again
12050 * without executing its draw method.</p>
12051 *
12052 * @return A HardwareLayer ready to render, or null if an error occurred.
12053 */
Michael Jurka7e52caf2012-03-06 15:57:06 -080012054 HardwareLayer getHardwareLayer() {
Romain Guyea835032011-07-28 19:24:37 -070012055 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null ||
12056 !mAttachInfo.mHardwareRenderer.isEnabled()) {
Romain Guy6c319ca2011-01-11 14:29:25 -080012057 return null;
12058 }
Philip Milne6c8ea062012-04-03 17:38:43 -070012059
Romain Guy9c4b79a2011-11-10 19:23:58 -080012060 if (!mAttachInfo.mHardwareRenderer.validate()) return null;
Romain Guy6c319ca2011-01-11 14:29:25 -080012061
12062 final int width = mRight - mLeft;
12063 final int height = mBottom - mTop;
Joe Malin32736f02011-01-19 16:14:20 -080012064
Romain Guy6c319ca2011-01-11 14:29:25 -080012065 if (width == 0 || height == 0) {
12066 return null;
12067 }
12068
Dianne Hackborn4702a852012-08-17 15:18:29 -070012069 if ((mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == 0 || mHardwareLayer == null) {
Romain Guy6c319ca2011-01-11 14:29:25 -080012070 if (mHardwareLayer == null) {
12071 mHardwareLayer = mAttachInfo.mHardwareRenderer.createHardwareLayer(
12072 width, height, isOpaque());
Michael Jurka952e02b2012-03-13 18:34:35 -070012073 mLocalDirtyRect.set(0, 0, width, height);
Romain Guy846a5332012-07-11 17:44:57 -070012074 } else {
12075 if (mHardwareLayer.getWidth() != width || mHardwareLayer.getHeight() != height) {
12076 mHardwareLayer.resize(width, height);
12077 mLocalDirtyRect.set(0, 0, width, height);
12078 }
12079
12080 // This should not be necessary but applications that change
12081 // the parameters of their background drawable without calling
12082 // this.setBackground(Drawable) can leave the view in a bad state
12083 // (for instance isOpaque() returns true, but the background is
12084 // not opaque.)
12085 computeOpaqueFlags();
12086
12087 final boolean opaque = isOpaque();
12088 if (mHardwareLayer.isOpaque() != opaque) {
12089 mHardwareLayer.setOpaque(opaque);
12090 mLocalDirtyRect.set(0, 0, width, height);
12091 }
Romain Guy6c319ca2011-01-11 14:29:25 -080012092 }
12093
Romain Guy5cd5c3f2011-10-17 17:10:02 -070012094 // The layer is not valid if the underlying GPU resources cannot be allocated
12095 if (!mHardwareLayer.isValid()) {
12096 return null;
12097 }
12098
Chet Haasea1cff502012-02-21 13:43:44 -080012099 mHardwareLayer.redraw(getHardwareLayerDisplayList(mHardwareLayer), mLocalDirtyRect);
Michael Jurka7e52caf2012-03-06 15:57:06 -080012100 mLocalDirtyRect.setEmpty();
Romain Guy6c319ca2011-01-11 14:29:25 -080012101 }
12102
12103 return mHardwareLayer;
12104 }
Romain Guy171c5922011-01-06 10:04:23 -080012105
Romain Guy589b0bb2011-10-10 13:57:47 -070012106 /**
12107 * Destroys this View's hardware layer if possible.
Philip Milne6c8ea062012-04-03 17:38:43 -070012108 *
Romain Guy589b0bb2011-10-10 13:57:47 -070012109 * @return True if the layer was destroyed, false otherwise.
Philip Milne6c8ea062012-04-03 17:38:43 -070012110 *
12111 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy589b0bb2011-10-10 13:57:47 -070012112 * @see #LAYER_TYPE_HARDWARE
12113 */
Romain Guya998dff2012-03-23 18:58:36 -070012114 boolean destroyLayer(boolean valid) {
Romain Guy6d7475d2011-07-27 16:28:21 -070012115 if (mHardwareLayer != null) {
Romain Guy9c4b79a2011-11-10 19:23:58 -080012116 AttachInfo info = mAttachInfo;
12117 if (info != null && info.mHardwareRenderer != null &&
Romain Guya998dff2012-03-23 18:58:36 -070012118 info.mHardwareRenderer.isEnabled() &&
12119 (valid || info.mHardwareRenderer.validate())) {
Romain Guy9c4b79a2011-11-10 19:23:58 -080012120 mHardwareLayer.destroy();
12121 mHardwareLayer = null;
Romain Guy31f2c2e2011-11-21 10:55:41 -080012122
Romain Guy9c4b79a2011-11-10 19:23:58 -080012123 invalidate(true);
12124 invalidateParentCaches();
12125 }
Romain Guy65b345f2011-07-27 18:51:50 -070012126 return true;
Romain Guy6d7475d2011-07-27 16:28:21 -070012127 }
Romain Guy65b345f2011-07-27 18:51:50 -070012128 return false;
Romain Guy6d7475d2011-07-27 16:28:21 -070012129 }
12130
Romain Guy171c5922011-01-06 10:04:23 -080012131 /**
Romain Guy31f2c2e2011-11-21 10:55:41 -080012132 * Destroys all hardware rendering resources. This method is invoked
12133 * when the system needs to reclaim resources. Upon execution of this
12134 * method, you should free any OpenGL resources created by the view.
Philip Milne6c8ea062012-04-03 17:38:43 -070012135 *
Romain Guy31f2c2e2011-11-21 10:55:41 -080012136 * Note: you <strong>must</strong> call
12137 * <code>super.destroyHardwareResources()</code> when overriding
12138 * this method.
Philip Milne6c8ea062012-04-03 17:38:43 -070012139 *
Romain Guy31f2c2e2011-11-21 10:55:41 -080012140 * @hide
12141 */
12142 protected void destroyHardwareResources() {
Romain Guya998dff2012-03-23 18:58:36 -070012143 destroyLayer(true);
Romain Guy31f2c2e2011-11-21 10:55:41 -080012144 }
12145
12146 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012147 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call
12148 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a
12149 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when
12150 * the cache is enabled. To benefit from the cache, you must request the drawing cache by
12151 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not
12152 * null.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012153 *
Romain Guy171c5922011-01-06 10:04:23 -080012154 * <p>Enabling the drawing cache is similar to
12155 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware
Chet Haasedaf98e92011-01-10 14:10:36 -080012156 * acceleration is turned off. When hardware acceleration is turned on, enabling the
12157 * drawing cache has no effect on rendering because the system uses a different mechanism
12158 * for acceleration which ignores the flag. If you want to use a Bitmap for the view, even
12159 * when hardware acceleration is enabled, see {@link #setLayerType(int, android.graphics.Paint)}
12160 * for information on how to enable software and hardware layers.</p>
12161 *
12162 * <p>This API can be used to manually generate
12163 * a bitmap copy of this view, by setting the flag to <code>true</code> and calling
12164 * {@link #getDrawingCache()}.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012165 *
12166 * @param enabled true to enable the drawing cache, false otherwise
12167 *
12168 * @see #isDrawingCacheEnabled()
12169 * @see #getDrawingCache()
12170 * @see #buildDrawingCache()
Joe Malin32736f02011-01-19 16:14:20 -080012171 * @see #setLayerType(int, android.graphics.Paint)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012172 */
12173 public void setDrawingCacheEnabled(boolean enabled) {
Romain Guy0211a0a2011-02-14 16:34:59 -080012174 mCachingFailed = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012175 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED);
12176 }
12177
12178 /**
12179 * <p>Indicates whether the drawing cache is enabled for this view.</p>
12180 *
12181 * @return true if the drawing cache is enabled
12182 *
12183 * @see #setDrawingCacheEnabled(boolean)
12184 * @see #getDrawingCache()
12185 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070012186 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012187 public boolean isDrawingCacheEnabled() {
12188 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED;
12189 }
12190
12191 /**
Chet Haasedaf98e92011-01-10 14:10:36 -080012192 * Debugging utility which recursively outputs the dirty state of a view and its
12193 * descendants.
Joe Malin32736f02011-01-19 16:14:20 -080012194 *
Chet Haasedaf98e92011-01-10 14:10:36 -080012195 * @hide
12196 */
Romain Guy676b1732011-02-14 14:45:33 -080012197 @SuppressWarnings({"UnusedDeclaration"})
Chet Haasedaf98e92011-01-10 14:10:36 -080012198 public void outputDirtyFlags(String indent, boolean clear, int clearMask) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070012199 Log.d("View", indent + this + " DIRTY(" + (mPrivateFlags & View.PFLAG_DIRTY_MASK) +
12200 ") DRAWN(" + (mPrivateFlags & PFLAG_DRAWN) + ")" + " CACHE_VALID(" +
12201 (mPrivateFlags & View.PFLAG_DRAWING_CACHE_VALID) +
12202 ") INVALIDATED(" + (mPrivateFlags & PFLAG_INVALIDATED) + ")");
Chet Haasedaf98e92011-01-10 14:10:36 -080012203 if (clear) {
12204 mPrivateFlags &= clearMask;
12205 }
12206 if (this instanceof ViewGroup) {
12207 ViewGroup parent = (ViewGroup) this;
12208 final int count = parent.getChildCount();
12209 for (int i = 0; i < count; i++) {
Romain Guy7d7b5492011-01-24 16:33:45 -080012210 final View child = parent.getChildAt(i);
Chet Haasedaf98e92011-01-10 14:10:36 -080012211 child.outputDirtyFlags(indent + " ", clear, clearMask);
12212 }
12213 }
12214 }
12215
12216 /**
12217 * This method is used by ViewGroup to cause its children to restore or recreate their
12218 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need
12219 * to recreate its own display list, which would happen if it went through the normal
12220 * draw/dispatchDraw mechanisms.
12221 *
12222 * @hide
12223 */
12224 protected void dispatchGetDisplayList() {}
Chet Haasef4ac5472011-01-27 10:30:25 -080012225
12226 /**
12227 * A view that is not attached or hardware accelerated cannot create a display list.
12228 * This method checks these conditions and returns the appropriate result.
12229 *
12230 * @return true if view has the ability to create a display list, false otherwise.
12231 *
12232 * @hide
12233 */
12234 public boolean canHaveDisplayList() {
Romain Guy676b1732011-02-14 14:45:33 -080012235 return !(mAttachInfo == null || mAttachInfo.mHardwareRenderer == null);
Chet Haasef4ac5472011-01-27 10:30:25 -080012236 }
Joe Malin32736f02011-01-19 16:14:20 -080012237
Chet Haasedaf98e92011-01-10 14:10:36 -080012238 /**
Gilles Debunneb35ab7b2011-12-05 15:54:00 -080012239 * @return The HardwareRenderer associated with that view or null if hardware rendering
12240 * is not supported or this this has not been attached to a window.
12241 *
12242 * @hide
12243 */
12244 public HardwareRenderer getHardwareRenderer() {
12245 if (mAttachInfo != null) {
12246 return mAttachInfo.mHardwareRenderer;
12247 }
12248 return null;
12249 }
12250
12251 /**
Chet Haasea1cff502012-02-21 13:43:44 -080012252 * Returns a DisplayList. If the incoming displayList is null, one will be created.
12253 * Otherwise, the same display list will be returned (after having been rendered into
12254 * along the way, depending on the invalidation state of the view).
12255 *
12256 * @param displayList The previous version of this displayList, could be null.
12257 * @param isLayer Whether the requester of the display list is a layer. If so,
12258 * the view will avoid creating a layer inside the resulting display list.
12259 * @return A new or reused DisplayList object.
12260 */
12261 private DisplayList getDisplayList(DisplayList displayList, boolean isLayer) {
12262 if (!canHaveDisplayList()) {
12263 return null;
12264 }
12265
Dianne Hackborn4702a852012-08-17 15:18:29 -070012266 if (((mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == 0 ||
Chet Haasea1cff502012-02-21 13:43:44 -080012267 displayList == null || !displayList.isValid() ||
12268 (!isLayer && mRecreateDisplayList))) {
12269 // Don't need to recreate the display list, just need to tell our
12270 // children to restore/recreate theirs
12271 if (displayList != null && displayList.isValid() &&
12272 !isLayer && !mRecreateDisplayList) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070012273 mPrivateFlags |= PFLAG_DRAWN | PFLAG_DRAWING_CACHE_VALID;
12274 mPrivateFlags &= ~PFLAG_DIRTY_MASK;
Chet Haasea1cff502012-02-21 13:43:44 -080012275 dispatchGetDisplayList();
12276
12277 return displayList;
12278 }
12279
12280 if (!isLayer) {
12281 // If we got here, we're recreating it. Mark it as such to ensure that
12282 // we copy in child display lists into ours in drawChild()
12283 mRecreateDisplayList = true;
12284 }
12285 if (displayList == null) {
12286 final String name = getClass().getSimpleName();
12287 displayList = mAttachInfo.mHardwareRenderer.createDisplayList(name);
12288 // If we're creating a new display list, make sure our parent gets invalidated
12289 // since they will need to recreate their display list to account for this
12290 // new child display list.
12291 invalidateParentCaches();
12292 }
12293
12294 boolean caching = false;
12295 final HardwareCanvas canvas = displayList.start();
Chet Haasea1cff502012-02-21 13:43:44 -080012296 int width = mRight - mLeft;
12297 int height = mBottom - mTop;
12298
12299 try {
12300 canvas.setViewport(width, height);
12301 // The dirty rect should always be null for a display list
12302 canvas.onPreDraw(null);
Michael Jurkaba649742012-06-28 19:12:58 -070012303 int layerType = getLayerType();
Chet Haase1271e2c2012-04-20 09:54:27 -070012304 if (!isLayer && layerType != LAYER_TYPE_NONE) {
Chet Haaseb85967b2012-03-26 14:37:51 -070012305 if (layerType == LAYER_TYPE_HARDWARE) {
12306 final HardwareLayer layer = getHardwareLayer();
12307 if (layer != null && layer.isValid()) {
12308 canvas.drawHardwareLayer(layer, 0, 0, mLayerPaint);
12309 } else {
12310 canvas.saveLayer(0, 0, mRight - mLeft, mBottom - mTop, mLayerPaint,
12311 Canvas.HAS_ALPHA_LAYER_SAVE_FLAG |
12312 Canvas.CLIP_TO_LAYER_SAVE_FLAG);
12313 }
12314 caching = true;
Chet Haasea1cff502012-02-21 13:43:44 -080012315 } else {
Chet Haaseb85967b2012-03-26 14:37:51 -070012316 buildDrawingCache(true);
12317 Bitmap cache = getDrawingCache(true);
12318 if (cache != null) {
12319 canvas.drawBitmap(cache, 0, 0, mLayerPaint);
12320 caching = true;
12321 }
Chet Haasea1cff502012-02-21 13:43:44 -080012322 }
Chet Haasea1cff502012-02-21 13:43:44 -080012323 } else {
12324
12325 computeScroll();
12326
Chet Haasea1cff502012-02-21 13:43:44 -080012327 canvas.translate(-mScrollX, -mScrollY);
12328 if (!isLayer) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070012329 mPrivateFlags |= PFLAG_DRAWN | PFLAG_DRAWING_CACHE_VALID;
12330 mPrivateFlags &= ~PFLAG_DIRTY_MASK;
Chet Haasea1cff502012-02-21 13:43:44 -080012331 }
12332
12333 // Fast path for layouts with no backgrounds
Dianne Hackborn4702a852012-08-17 15:18:29 -070012334 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) {
Chet Haasea1cff502012-02-21 13:43:44 -080012335 dispatchDraw(canvas);
12336 } else {
12337 draw(canvas);
12338 }
12339 }
12340 } finally {
Chet Haasea1cff502012-02-21 13:43:44 -080012341 canvas.onPostDraw();
12342
12343 displayList.end();
Chet Haase1271e2c2012-04-20 09:54:27 -070012344 displayList.setCaching(caching);
12345 if (isLayer) {
Chet Haasea1cff502012-02-21 13:43:44 -080012346 displayList.setLeftTopRightBottom(0, 0, width, height);
12347 } else {
12348 setDisplayListProperties(displayList);
12349 }
12350 }
12351 } else if (!isLayer) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070012352 mPrivateFlags |= PFLAG_DRAWN | PFLAG_DRAWING_CACHE_VALID;
12353 mPrivateFlags &= ~PFLAG_DIRTY_MASK;
Chet Haasea1cff502012-02-21 13:43:44 -080012354 }
12355
12356 return displayList;
12357 }
12358
12359 /**
12360 * Get the DisplayList for the HardwareLayer
12361 *
12362 * @param layer The HardwareLayer whose DisplayList we want
12363 * @return A DisplayList fopr the specified HardwareLayer
12364 */
12365 private DisplayList getHardwareLayerDisplayList(HardwareLayer layer) {
12366 DisplayList displayList = getDisplayList(layer.getDisplayList(), true);
12367 layer.setDisplayList(displayList);
12368 return displayList;
12369 }
12370
12371
12372 /**
Romain Guyb051e892010-09-28 19:09:36 -070012373 * <p>Returns a display list that can be used to draw this view again
12374 * without executing its draw method.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012375 *
Romain Guyb051e892010-09-28 19:09:36 -070012376 * @return A DisplayList ready to replay, or null if caching is not enabled.
Chet Haasedaf98e92011-01-10 14:10:36 -080012377 *
12378 * @hide
Romain Guyb051e892010-09-28 19:09:36 -070012379 */
Chet Haasedaf98e92011-01-10 14:10:36 -080012380 public DisplayList getDisplayList() {
Chet Haasea1cff502012-02-21 13:43:44 -080012381 mDisplayList = getDisplayList(mDisplayList, false);
Romain Guyb051e892010-09-28 19:09:36 -070012382 return mDisplayList;
12383 }
12384
Romain Guy38c2ece2012-05-24 14:20:56 -070012385 private void clearDisplayList() {
12386 if (mDisplayList != null) {
12387 mDisplayList.invalidate();
12388 mDisplayList.clear();
12389 }
12390 }
12391
Romain Guyb051e892010-09-28 19:09:36 -070012392 /**
Romain Guyfbd8f692009-06-26 14:51:58 -070012393 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012394 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012395 * @return A non-scaled bitmap representing this view or null if cache is disabled.
Joe Malin32736f02011-01-19 16:14:20 -080012396 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012397 * @see #getDrawingCache(boolean)
12398 */
12399 public Bitmap getDrawingCache() {
12400 return getDrawingCache(false);
12401 }
12402
12403 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012404 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap
12405 * is null when caching is disabled. If caching is enabled and the cache is not ready,
12406 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not
12407 * draw from the cache when the cache is enabled. To benefit from the cache, you must
12408 * request the drawing cache by calling this method and draw it on screen if the
12409 * returned bitmap is not null.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012410 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012411 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
12412 * this method will create a bitmap of the same size as this view. Because this bitmap
12413 * will be drawn scaled by the parent ViewGroup, the result on screen might show
12414 * scaling artifacts. To avoid such artifacts, you should call this method by setting
12415 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
12416 * size than the view. This implies that your application must be able to handle this
12417 * size.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012418 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012419 * @param autoScale Indicates whether the generated bitmap should be scaled based on
12420 * the current density of the screen when the application is in compatibility
12421 * mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012422 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012423 * @return A bitmap representing this view or null if cache is disabled.
Joe Malin32736f02011-01-19 16:14:20 -080012424 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012425 * @see #setDrawingCacheEnabled(boolean)
12426 * @see #isDrawingCacheEnabled()
Romain Guyfbd8f692009-06-26 14:51:58 -070012427 * @see #buildDrawingCache(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012428 * @see #destroyDrawingCache()
12429 */
Romain Guyfbd8f692009-06-26 14:51:58 -070012430 public Bitmap getDrawingCache(boolean autoScale) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012431 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) {
12432 return null;
12433 }
12434 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) {
Romain Guyfbd8f692009-06-26 14:51:58 -070012435 buildDrawingCache(autoScale);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012436 }
Romain Guy02890fd2010-08-06 17:58:44 -070012437 return autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012438 }
12439
12440 /**
12441 * <p>Frees the resources used by the drawing cache. If you call
12442 * {@link #buildDrawingCache()} manually without calling
12443 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
12444 * should cleanup the cache with this method afterwards.</p>
12445 *
12446 * @see #setDrawingCacheEnabled(boolean)
12447 * @see #buildDrawingCache()
12448 * @see #getDrawingCache()
12449 */
12450 public void destroyDrawingCache() {
12451 if (mDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -070012452 mDrawingCache.recycle();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012453 mDrawingCache = null;
12454 }
Romain Guyfbd8f692009-06-26 14:51:58 -070012455 if (mUnscaledDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -070012456 mUnscaledDrawingCache.recycle();
Romain Guyfbd8f692009-06-26 14:51:58 -070012457 mUnscaledDrawingCache = null;
12458 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012459 }
12460
12461 /**
12462 * Setting a solid background color for the drawing cache's bitmaps will improve
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070012463 * performance and memory usage. Note, though that this should only be used if this
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012464 * view will always be drawn on top of a solid color.
12465 *
12466 * @param color The background color to use for the drawing cache's bitmap
12467 *
12468 * @see #setDrawingCacheEnabled(boolean)
12469 * @see #buildDrawingCache()
12470 * @see #getDrawingCache()
12471 */
12472 public void setDrawingCacheBackgroundColor(int color) {
Romain Guy52e2ef82010-01-14 12:11:48 -080012473 if (color != mDrawingCacheBackgroundColor) {
12474 mDrawingCacheBackgroundColor = color;
Dianne Hackborn4702a852012-08-17 15:18:29 -070012475 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID;
Romain Guy52e2ef82010-01-14 12:11:48 -080012476 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012477 }
12478
12479 /**
12480 * @see #setDrawingCacheBackgroundColor(int)
12481 *
12482 * @return The background color to used for the drawing cache's bitmap
12483 */
12484 public int getDrawingCacheBackgroundColor() {
12485 return mDrawingCacheBackgroundColor;
12486 }
12487
12488 /**
Romain Guyfbd8f692009-06-26 14:51:58 -070012489 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012490 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012491 * @see #buildDrawingCache(boolean)
12492 */
12493 public void buildDrawingCache() {
12494 buildDrawingCache(false);
12495 }
Gilles Debunne2ed2eac2011-02-24 16:29:48 -080012496
Romain Guyfbd8f692009-06-26 14:51:58 -070012497 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012498 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p>
12499 *
12500 * <p>If you call {@link #buildDrawingCache()} manually without calling
12501 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
12502 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012503 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012504 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
12505 * this method will create a bitmap of the same size as this view. Because this bitmap
12506 * will be drawn scaled by the parent ViewGroup, the result on screen might show
12507 * scaling artifacts. To avoid such artifacts, you should call this method by setting
12508 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
12509 * size than the view. This implies that your application must be able to handle this
12510 * size.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012511 *
Romain Guy0d9275e2010-10-26 14:22:30 -070012512 * <p>You should avoid calling this method when hardware acceleration is enabled. If
12513 * you do not need the drawing cache bitmap, calling this method will increase memory
Joe Malin32736f02011-01-19 16:14:20 -080012514 * usage and cause the view to be rendered in software once, thus negatively impacting
Romain Guy0d9275e2010-10-26 14:22:30 -070012515 * performance.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012516 *
12517 * @see #getDrawingCache()
12518 * @see #destroyDrawingCache()
12519 */
Romain Guyfbd8f692009-06-26 14:51:58 -070012520 public void buildDrawingCache(boolean autoScale) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070012521 if ((mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == 0 || (autoScale ?
Romain Guy02890fd2010-08-06 17:58:44 -070012522 mDrawingCache == null : mUnscaledDrawingCache == null)) {
Romain Guy0211a0a2011-02-14 16:34:59 -080012523 mCachingFailed = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012524
Romain Guy8506ab42009-06-11 17:35:47 -070012525 int width = mRight - mLeft;
12526 int height = mBottom - mTop;
12527
12528 final AttachInfo attachInfo = mAttachInfo;
Romain Guye1123222009-06-29 14:24:56 -070012529 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired;
Romain Guyfbd8f692009-06-26 14:51:58 -070012530
Romain Guye1123222009-06-29 14:24:56 -070012531 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -070012532 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f);
12533 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f);
Romain Guy8506ab42009-06-11 17:35:47 -070012534 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012535
12536 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor;
Romain Guy35b38ce2009-10-07 13:38:55 -070012537 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque();
Adam Powell26153a32010-11-08 15:22:27 -080012538 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012539
Chris Craik10e9d1d2012-09-06 14:42:44 -070012540 final int projectedBitmapSize = width * height * (opaque && !use32BitCache ? 2 : 4);
12541 final int drawingCacheSize =
12542 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize();
12543 if (width <= 0 || height <= 0 || projectedBitmapSize > drawingCacheSize) {
Chris Craik3667aa32012-09-06 14:56:39 -070012544 if (width > 0 && height > 0) {
12545 Log.w(VIEW_LOG_TAG, "View too large to fit into drawing cache, needs "
12546 + projectedBitmapSize + " bytes, only "
12547 + drawingCacheSize + " available");
12548 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012549 destroyDrawingCache();
Romain Guy0211a0a2011-02-14 16:34:59 -080012550 mCachingFailed = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012551 return;
12552 }
12553
12554 boolean clear = true;
Romain Guy02890fd2010-08-06 17:58:44 -070012555 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012556
12557 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012558 Bitmap.Config quality;
12559 if (!opaque) {
Romain Guy676b1732011-02-14 14:45:33 -080012560 // Never pick ARGB_4444 because it looks awful
12561 // Keep the DRAWING_CACHE_QUALITY_LOW flag just in case
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012562 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) {
12563 case DRAWING_CACHE_QUALITY_AUTO:
12564 quality = Bitmap.Config.ARGB_8888;
12565 break;
12566 case DRAWING_CACHE_QUALITY_LOW:
Romain Guy676b1732011-02-14 14:45:33 -080012567 quality = Bitmap.Config.ARGB_8888;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012568 break;
12569 case DRAWING_CACHE_QUALITY_HIGH:
12570 quality = Bitmap.Config.ARGB_8888;
12571 break;
12572 default:
12573 quality = Bitmap.Config.ARGB_8888;
12574 break;
12575 }
12576 } else {
Romain Guy35b38ce2009-10-07 13:38:55 -070012577 // Optimization for translucent windows
12578 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy()
Adam Powell26153a32010-11-08 15:22:27 -080012579 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012580 }
12581
12582 // Try to cleanup memory
12583 if (bitmap != null) bitmap.recycle();
12584
12585 try {
Dianne Hackborndde331c2012-08-03 14:01:57 -070012586 bitmap = Bitmap.createBitmap(mResources.getDisplayMetrics(),
12587 width, height, quality);
Dianne Hackborn11ea3342009-07-22 21:48:55 -070012588 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
Romain Guyfbd8f692009-06-26 14:51:58 -070012589 if (autoScale) {
Romain Guy02890fd2010-08-06 17:58:44 -070012590 mDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -070012591 } else {
Romain Guy02890fd2010-08-06 17:58:44 -070012592 mUnscaledDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -070012593 }
Adam Powell26153a32010-11-08 15:22:27 -080012594 if (opaque && use32BitCache) bitmap.setHasAlpha(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012595 } catch (OutOfMemoryError e) {
12596 // If there is not enough memory to create the bitmap cache, just
12597 // ignore the issue as bitmap caches are not required to draw the
12598 // view hierarchy
Romain Guyfbd8f692009-06-26 14:51:58 -070012599 if (autoScale) {
12600 mDrawingCache = null;
12601 } else {
12602 mUnscaledDrawingCache = null;
12603 }
Romain Guy0211a0a2011-02-14 16:34:59 -080012604 mCachingFailed = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012605 return;
12606 }
12607
12608 clear = drawingCacheBackgroundColor != 0;
12609 }
12610
12611 Canvas canvas;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012612 if (attachInfo != null) {
12613 canvas = attachInfo.mCanvas;
12614 if (canvas == null) {
12615 canvas = new Canvas();
12616 }
12617 canvas.setBitmap(bitmap);
12618 // Temporarily clobber the cached Canvas in case one of our children
12619 // is also using a drawing cache. Without this, the children would
12620 // steal the canvas by attaching their own bitmap to it and bad, bad
12621 // thing would happen (invisible views, corrupted drawings, etc.)
12622 attachInfo.mCanvas = null;
12623 } else {
12624 // This case should hopefully never or seldom happen
12625 canvas = new Canvas(bitmap);
12626 }
12627
12628 if (clear) {
12629 bitmap.eraseColor(drawingCacheBackgroundColor);
12630 }
12631
12632 computeScroll();
12633 final int restoreCount = canvas.save();
Joe Malin32736f02011-01-19 16:14:20 -080012634
Romain Guye1123222009-06-29 14:24:56 -070012635 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -070012636 final float scale = attachInfo.mApplicationScale;
12637 canvas.scale(scale, scale);
12638 }
Joe Malin32736f02011-01-19 16:14:20 -080012639
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012640 canvas.translate(-mScrollX, -mScrollY);
12641
Dianne Hackborn4702a852012-08-17 15:18:29 -070012642 mPrivateFlags |= PFLAG_DRAWN;
Romain Guy171c5922011-01-06 10:04:23 -080012643 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated ||
12644 mLayerType != LAYER_TYPE_NONE) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070012645 mPrivateFlags |= PFLAG_DRAWING_CACHE_VALID;
Romain Guy0d9275e2010-10-26 14:22:30 -070012646 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012647
12648 // Fast path for layouts with no backgrounds
Dianne Hackborn4702a852012-08-17 15:18:29 -070012649 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) {
12650 mPrivateFlags &= ~PFLAG_DIRTY_MASK;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012651 dispatchDraw(canvas);
12652 } else {
12653 draw(canvas);
12654 }
12655
12656 canvas.restoreToCount(restoreCount);
Dianne Hackborn6311d0a2011-08-02 16:37:58 -070012657 canvas.setBitmap(null);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012658
12659 if (attachInfo != null) {
12660 // Restore the cached Canvas for our siblings
12661 attachInfo.mCanvas = canvas;
12662 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012663 }
12664 }
12665
12666 /**
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012667 * Create a snapshot of the view into a bitmap. We should probably make
12668 * some form of this public, but should think about the API.
12669 */
Romain Guy223ff5c2010-03-02 17:07:47 -080012670 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) {
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012671 int width = mRight - mLeft;
12672 int height = mBottom - mTop;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012673
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012674 final AttachInfo attachInfo = mAttachInfo;
Romain Guy8c11e312009-09-14 15:15:30 -070012675 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f;
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012676 width = (int) ((width * scale) + 0.5f);
12677 height = (int) ((height * scale) + 0.5f);
Joe Malin32736f02011-01-19 16:14:20 -080012678
Dianne Hackborndde331c2012-08-03 14:01:57 -070012679 Bitmap bitmap = Bitmap.createBitmap(mResources.getDisplayMetrics(),
12680 width > 0 ? width : 1, height > 0 ? height : 1, quality);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012681 if (bitmap == null) {
12682 throw new OutOfMemoryError();
12683 }
12684
Romain Guyc529d8d2011-09-06 15:01:39 -070012685 Resources resources = getResources();
12686 if (resources != null) {
12687 bitmap.setDensity(resources.getDisplayMetrics().densityDpi);
12688 }
Joe Malin32736f02011-01-19 16:14:20 -080012689
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012690 Canvas canvas;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012691 if (attachInfo != null) {
12692 canvas = attachInfo.mCanvas;
12693 if (canvas == null) {
12694 canvas = new Canvas();
12695 }
12696 canvas.setBitmap(bitmap);
12697 // Temporarily clobber the cached Canvas in case one of our children
12698 // is also using a drawing cache. Without this, the children would
12699 // steal the canvas by attaching their own bitmap to it and bad, bad
12700 // things would happen (invisible views, corrupted drawings, etc.)
12701 attachInfo.mCanvas = null;
12702 } else {
12703 // This case should hopefully never or seldom happen
12704 canvas = new Canvas(bitmap);
12705 }
12706
Romain Guy5bcdff42009-05-14 21:27:18 -070012707 if ((backgroundColor & 0xff000000) != 0) {
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012708 bitmap.eraseColor(backgroundColor);
12709 }
12710
12711 computeScroll();
12712 final int restoreCount = canvas.save();
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012713 canvas.scale(scale, scale);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012714 canvas.translate(-mScrollX, -mScrollY);
12715
Romain Guy5bcdff42009-05-14 21:27:18 -070012716 // Temporarily remove the dirty mask
12717 int flags = mPrivateFlags;
Dianne Hackborn4702a852012-08-17 15:18:29 -070012718 mPrivateFlags &= ~PFLAG_DIRTY_MASK;
Romain Guy5bcdff42009-05-14 21:27:18 -070012719
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012720 // Fast path for layouts with no backgrounds
Dianne Hackborn4702a852012-08-17 15:18:29 -070012721 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) {
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012722 dispatchDraw(canvas);
12723 } else {
12724 draw(canvas);
12725 }
12726
Romain Guy5bcdff42009-05-14 21:27:18 -070012727 mPrivateFlags = flags;
12728
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012729 canvas.restoreToCount(restoreCount);
Dianne Hackborn6311d0a2011-08-02 16:37:58 -070012730 canvas.setBitmap(null);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012731
12732 if (attachInfo != null) {
12733 // Restore the cached Canvas for our siblings
12734 attachInfo.mCanvas = canvas;
12735 }
Romain Guy8506ab42009-06-11 17:35:47 -070012736
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012737 return bitmap;
12738 }
12739
12740 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012741 * Indicates whether this View is currently in edit mode. A View is usually
12742 * in edit mode when displayed within a developer tool. For instance, if
12743 * this View is being drawn by a visual user interface builder, this method
12744 * should return true.
12745 *
12746 * Subclasses should check the return value of this method to provide
12747 * different behaviors if their normal behavior might interfere with the
12748 * host environment. For instance: the class spawns a thread in its
12749 * constructor, the drawing code relies on device-specific features, etc.
12750 *
12751 * This method is usually checked in the drawing code of custom widgets.
12752 *
12753 * @return True if this View is in edit mode, false otherwise.
12754 */
12755 public boolean isInEditMode() {
12756 return false;
12757 }
12758
12759 /**
12760 * If the View draws content inside its padding and enables fading edges,
12761 * it needs to support padding offsets. Padding offsets are added to the
12762 * fading edges to extend the length of the fade so that it covers pixels
12763 * drawn inside the padding.
12764 *
12765 * Subclasses of this class should override this method if they need
12766 * to draw content inside the padding.
12767 *
12768 * @return True if padding offset must be applied, false otherwise.
12769 *
12770 * @see #getLeftPaddingOffset()
12771 * @see #getRightPaddingOffset()
12772 * @see #getTopPaddingOffset()
12773 * @see #getBottomPaddingOffset()
12774 *
12775 * @since CURRENT
12776 */
12777 protected boolean isPaddingOffsetRequired() {
12778 return false;
12779 }
12780
12781 /**
12782 * Amount by which to extend the left fading region. Called only when
12783 * {@link #isPaddingOffsetRequired()} returns true.
12784 *
12785 * @return The left padding offset in pixels.
12786 *
12787 * @see #isPaddingOffsetRequired()
12788 *
12789 * @since CURRENT
12790 */
12791 protected int getLeftPaddingOffset() {
12792 return 0;
12793 }
12794
12795 /**
12796 * Amount by which to extend the right fading region. Called only when
12797 * {@link #isPaddingOffsetRequired()} returns true.
12798 *
12799 * @return The right padding offset in pixels.
12800 *
12801 * @see #isPaddingOffsetRequired()
12802 *
12803 * @since CURRENT
12804 */
12805 protected int getRightPaddingOffset() {
12806 return 0;
12807 }
12808
12809 /**
12810 * Amount by which to extend the top fading region. Called only when
12811 * {@link #isPaddingOffsetRequired()} returns true.
12812 *
12813 * @return The top padding offset in pixels.
12814 *
12815 * @see #isPaddingOffsetRequired()
12816 *
12817 * @since CURRENT
12818 */
12819 protected int getTopPaddingOffset() {
12820 return 0;
12821 }
12822
12823 /**
12824 * Amount by which to extend the bottom fading region. Called only when
12825 * {@link #isPaddingOffsetRequired()} returns true.
12826 *
12827 * @return The bottom padding offset in pixels.
12828 *
12829 * @see #isPaddingOffsetRequired()
12830 *
12831 * @since CURRENT
12832 */
12833 protected int getBottomPaddingOffset() {
12834 return 0;
12835 }
12836
12837 /**
Romain Guyf2fc4602011-07-19 15:20:03 -070012838 * @hide
12839 * @param offsetRequired
12840 */
12841 protected int getFadeTop(boolean offsetRequired) {
12842 int top = mPaddingTop;
12843 if (offsetRequired) top += getTopPaddingOffset();
12844 return top;
12845 }
Philip Milne6c8ea062012-04-03 17:38:43 -070012846
Romain Guyf2fc4602011-07-19 15:20:03 -070012847 /**
12848 * @hide
12849 * @param offsetRequired
12850 */
12851 protected int getFadeHeight(boolean offsetRequired) {
12852 int padding = mPaddingTop;
Philip Milne6c8ea062012-04-03 17:38:43 -070012853 if (offsetRequired) padding += getTopPaddingOffset();
Romain Guyf2fc4602011-07-19 15:20:03 -070012854 return mBottom - mTop - mPaddingBottom - padding;
12855 }
Philip Milne6c8ea062012-04-03 17:38:43 -070012856
Romain Guyf2fc4602011-07-19 15:20:03 -070012857 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +090012858 * <p>Indicates whether this view is attached to a hardware accelerated
Romain Guy2bffd262010-09-12 17:40:02 -070012859 * window or not.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012860 *
Romain Guy2bffd262010-09-12 17:40:02 -070012861 * <p>Even if this method returns true, it does not mean that every call
12862 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware
12863 * accelerated {@link android.graphics.Canvas}. For instance, if this view
Ken Wakasaf76a50c2012-03-09 19:56:35 +090012864 * is drawn onto an offscreen {@link android.graphics.Bitmap} and its
Romain Guy2bffd262010-09-12 17:40:02 -070012865 * window is hardware accelerated,
12866 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely
12867 * return false, and this method will return true.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012868 *
Romain Guy2bffd262010-09-12 17:40:02 -070012869 * @return True if the view is attached to a window and the window is
12870 * hardware accelerated; false in any other case.
12871 */
12872 public boolean isHardwareAccelerated() {
12873 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated;
12874 }
Joe Malin32736f02011-01-19 16:14:20 -080012875
Romain Guy2bffd262010-09-12 17:40:02 -070012876 /**
Chet Haasebcca79a2012-02-14 08:45:14 -080012877 * Utility function, called by draw(canvas, parent, drawingTime) to handle the less common
12878 * case of an active Animation being run on the view.
12879 */
12880 private boolean drawAnimation(ViewGroup parent, long drawingTime,
12881 Animation a, boolean scalingRequired) {
12882 Transformation invalidationTransform;
12883 final int flags = parent.mGroupFlags;
12884 final boolean initialized = a.isInitialized();
12885 if (!initialized) {
Chet Haase1fb8a9e2012-04-19 09:22:34 -070012886 a.initialize(mRight - mLeft, mBottom - mTop, parent.getWidth(), parent.getHeight());
Chet Haasebcca79a2012-02-14 08:45:14 -080012887 a.initializeInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop);
Romain Guy393a52c2012-05-22 20:21:08 -070012888 if (mAttachInfo != null) a.setListenerHandler(mAttachInfo.mHandler);
Chet Haasebcca79a2012-02-14 08:45:14 -080012889 onAnimationStart();
12890 }
12891
12892 boolean more = a.getTransformation(drawingTime, parent.mChildTransformation, 1f);
12893 if (scalingRequired && mAttachInfo.mApplicationScale != 1f) {
12894 if (parent.mInvalidationTransformation == null) {
12895 parent.mInvalidationTransformation = new Transformation();
12896 }
12897 invalidationTransform = parent.mInvalidationTransformation;
12898 a.getTransformation(drawingTime, invalidationTransform, 1f);
12899 } else {
12900 invalidationTransform = parent.mChildTransformation;
12901 }
Romain Guy393a52c2012-05-22 20:21:08 -070012902
Chet Haasebcca79a2012-02-14 08:45:14 -080012903 if (more) {
12904 if (!a.willChangeBounds()) {
Romain Guyf0af1d52012-07-11 18:31:21 -070012905 if ((flags & (ViewGroup.FLAG_OPTIMIZE_INVALIDATE | ViewGroup.FLAG_ANIMATION_DONE)) ==
12906 ViewGroup.FLAG_OPTIMIZE_INVALIDATE) {
12907 parent.mGroupFlags |= ViewGroup.FLAG_INVALIDATE_REQUIRED;
12908 } else if ((flags & ViewGroup.FLAG_INVALIDATE_REQUIRED) == 0) {
Chet Haasebcca79a2012-02-14 08:45:14 -080012909 // The child need to draw an animation, potentially offscreen, so
12910 // make sure we do not cancel invalidate requests
Dianne Hackborn4702a852012-08-17 15:18:29 -070012911 parent.mPrivateFlags |= PFLAG_DRAW_ANIMATION;
Chet Haasebcca79a2012-02-14 08:45:14 -080012912 parent.invalidate(mLeft, mTop, mRight, mBottom);
12913 }
12914 } else {
12915 if (parent.mInvalidateRegion == null) {
12916 parent.mInvalidateRegion = new RectF();
12917 }
12918 final RectF region = parent.mInvalidateRegion;
12919 a.getInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop, region,
12920 invalidationTransform);
12921
12922 // The child need to draw an animation, potentially offscreen, so
12923 // make sure we do not cancel invalidate requests
Dianne Hackborn4702a852012-08-17 15:18:29 -070012924 parent.mPrivateFlags |= PFLAG_DRAW_ANIMATION;
Chet Haasebcca79a2012-02-14 08:45:14 -080012925
12926 final int left = mLeft + (int) region.left;
12927 final int top = mTop + (int) region.top;
12928 parent.invalidate(left, top, left + (int) (region.width() + .5f),
12929 top + (int) (region.height() + .5f));
12930 }
12931 }
12932 return more;
12933 }
12934
Chet Haasea1cff502012-02-21 13:43:44 -080012935 /**
12936 * This method is called by getDisplayList() when a display list is created or re-rendered.
12937 * It sets or resets the current value of all properties on that display list (resetting is
12938 * necessary when a display list is being re-created, because we need to make sure that
12939 * previously-set transform values
12940 */
12941 void setDisplayListProperties(DisplayList displayList) {
Chet Haase1271e2c2012-04-20 09:54:27 -070012942 if (displayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -080012943 displayList.setLeftTopRightBottom(mLeft, mTop, mRight, mBottom);
Chet Haasedb8c9a62012-03-21 18:54:18 -070012944 displayList.setHasOverlappingRendering(hasOverlappingRendering());
Chet Haasea1cff502012-02-21 13:43:44 -080012945 if (mParent instanceof ViewGroup) {
12946 displayList.setClipChildren(
12947 (((ViewGroup)mParent).mGroupFlags & ViewGroup.FLAG_CLIP_CHILDREN) != 0);
12948 }
Chet Haase9420abd2012-03-29 16:28:32 -070012949 float alpha = 1;
12950 if (mParent instanceof ViewGroup && (((ViewGroup) mParent).mGroupFlags &
12951 ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) {
12952 ViewGroup parentVG = (ViewGroup) mParent;
12953 final boolean hasTransform =
12954 parentVG.getChildStaticTransformation(this, parentVG.mChildTransformation);
12955 if (hasTransform) {
12956 Transformation transform = parentVG.mChildTransformation;
12957 final int transformType = parentVG.mChildTransformation.getTransformationType();
12958 if (transformType != Transformation.TYPE_IDENTITY) {
12959 if ((transformType & Transformation.TYPE_ALPHA) != 0) {
12960 alpha = transform.getAlpha();
12961 }
12962 if ((transformType & Transformation.TYPE_MATRIX) != 0) {
12963 displayList.setStaticMatrix(transform.getMatrix());
12964 }
12965 }
12966 }
Chet Haasea1cff502012-02-21 13:43:44 -080012967 }
12968 if (mTransformationInfo != null) {
Chet Haase9420abd2012-03-29 16:28:32 -070012969 alpha *= mTransformationInfo.mAlpha;
12970 if (alpha < 1) {
12971 final int multipliedAlpha = (int) (255 * alpha);
12972 if (onSetAlpha(multipliedAlpha)) {
12973 alpha = 1;
12974 }
12975 }
12976 displayList.setTransformationInfo(alpha,
Chet Haasea1cff502012-02-21 13:43:44 -080012977 mTransformationInfo.mTranslationX, mTransformationInfo.mTranslationY,
12978 mTransformationInfo.mRotation, mTransformationInfo.mRotationX,
12979 mTransformationInfo.mRotationY, mTransformationInfo.mScaleX,
12980 mTransformationInfo.mScaleY);
Chet Haaseb85967b2012-03-26 14:37:51 -070012981 if (mTransformationInfo.mCamera == null) {
12982 mTransformationInfo.mCamera = new Camera();
12983 mTransformationInfo.matrix3D = new Matrix();
12984 }
12985 displayList.setCameraDistance(mTransformationInfo.mCamera.getLocationZ());
Dianne Hackborn4702a852012-08-17 15:18:29 -070012986 if ((mPrivateFlags & PFLAG_PIVOT_EXPLICITLY_SET) == PFLAG_PIVOT_EXPLICITLY_SET) {
Chet Haasea1cff502012-02-21 13:43:44 -080012987 displayList.setPivotX(getPivotX());
12988 displayList.setPivotY(getPivotY());
12989 }
Chet Haase9420abd2012-03-29 16:28:32 -070012990 } else if (alpha < 1) {
12991 displayList.setAlpha(alpha);
Chet Haasea1cff502012-02-21 13:43:44 -080012992 }
12993 }
12994 }
12995
Chet Haasebcca79a2012-02-14 08:45:14 -080012996 /**
Chet Haase64a48c12012-02-13 16:33:29 -080012997 * This method is called by ViewGroup.drawChild() to have each child view draw itself.
12998 * This draw() method is an implementation detail and is not intended to be overridden or
12999 * to be called from anywhere else other than ViewGroup.drawChild().
13000 */
13001 boolean draw(Canvas canvas, ViewGroup parent, long drawingTime) {
Chet Haase1271e2c2012-04-20 09:54:27 -070013002 boolean useDisplayListProperties = mAttachInfo != null && mAttachInfo.mHardwareAccelerated;
Chet Haase64a48c12012-02-13 16:33:29 -080013003 boolean more = false;
Chet Haase64a48c12012-02-13 16:33:29 -080013004 final boolean childHasIdentityMatrix = hasIdentityMatrix();
Chet Haase64a48c12012-02-13 16:33:29 -080013005 final int flags = parent.mGroupFlags;
13006
Chet Haasea1cff502012-02-21 13:43:44 -080013007 if ((flags & ViewGroup.FLAG_CLEAR_TRANSFORMATION) == ViewGroup.FLAG_CLEAR_TRANSFORMATION) {
Chet Haase64a48c12012-02-13 16:33:29 -080013008 parent.mChildTransformation.clear();
Chet Haasea1cff502012-02-21 13:43:44 -080013009 parent.mGroupFlags &= ~ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080013010 }
13011
13012 Transformation transformToApply = null;
Chet Haase64a48c12012-02-13 16:33:29 -080013013 boolean concatMatrix = false;
13014
13015 boolean scalingRequired = false;
13016 boolean caching;
Michael Jurkaba649742012-06-28 19:12:58 -070013017 int layerType = getLayerType();
Chet Haase64a48c12012-02-13 16:33:29 -080013018
13019 final boolean hardwareAccelerated = canvas.isHardwareAccelerated();
Chet Haasea1cff502012-02-21 13:43:44 -080013020 if ((flags & ViewGroup.FLAG_CHILDREN_DRAWN_WITH_CACHE) != 0 ||
13021 (flags & ViewGroup.FLAG_ALWAYS_DRAWN_WITH_CACHE) != 0) {
Chet Haase64a48c12012-02-13 16:33:29 -080013022 caching = true;
Chet Haase9420abd2012-03-29 16:28:32 -070013023 // Auto-scaled apps are not hw-accelerated, no need to set scaling flag on DisplayList
Chet Haase64a48c12012-02-13 16:33:29 -080013024 if (mAttachInfo != null) scalingRequired = mAttachInfo.mScalingRequired;
13025 } else {
13026 caching = (layerType != LAYER_TYPE_NONE) || hardwareAccelerated;
13027 }
13028
Chet Haasebcca79a2012-02-14 08:45:14 -080013029 final Animation a = getAnimation();
Chet Haase64a48c12012-02-13 16:33:29 -080013030 if (a != null) {
Chet Haasebcca79a2012-02-14 08:45:14 -080013031 more = drawAnimation(parent, drawingTime, a, scalingRequired);
Chet Haase64a48c12012-02-13 16:33:29 -080013032 concatMatrix = a.willChangeTransformationMatrix();
Chet Haaseafd5c3e2012-05-10 13:21:10 -070013033 if (concatMatrix) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070013034 mPrivateFlags3 |= PFLAG3_VIEW_IS_ANIMATING_TRANSFORM;
Chet Haaseafd5c3e2012-05-10 13:21:10 -070013035 }
Chet Haasebcca79a2012-02-14 08:45:14 -080013036 transformToApply = parent.mChildTransformation;
Chet Haaseafd5c3e2012-05-10 13:21:10 -070013037 } else {
Dianne Hackborn4702a852012-08-17 15:18:29 -070013038 if ((mPrivateFlags3 & PFLAG3_VIEW_IS_ANIMATING_TRANSFORM) == PFLAG3_VIEW_IS_ANIMATING_TRANSFORM &&
Chet Haaseafd5c3e2012-05-10 13:21:10 -070013039 mDisplayList != null) {
13040 // No longer animating: clear out old animation matrix
13041 mDisplayList.setAnimationMatrix(null);
Dianne Hackborn4702a852012-08-17 15:18:29 -070013042 mPrivateFlags3 &= ~PFLAG3_VIEW_IS_ANIMATING_TRANSFORM;
Chet Haaseafd5c3e2012-05-10 13:21:10 -070013043 }
13044 if (!useDisplayListProperties &&
13045 (flags & ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) {
13046 final boolean hasTransform =
13047 parent.getChildStaticTransformation(this, parent.mChildTransformation);
13048 if (hasTransform) {
13049 final int transformType = parent.mChildTransformation.getTransformationType();
13050 transformToApply = transformType != Transformation.TYPE_IDENTITY ?
13051 parent.mChildTransformation : null;
13052 concatMatrix = (transformType & Transformation.TYPE_MATRIX) != 0;
13053 }
Chet Haase64a48c12012-02-13 16:33:29 -080013054 }
13055 }
13056
13057 concatMatrix |= !childHasIdentityMatrix;
13058
13059 // Sets the flag as early as possible to allow draw() implementations
13060 // to call invalidate() successfully when doing animations
Dianne Hackborn4702a852012-08-17 15:18:29 -070013061 mPrivateFlags |= PFLAG_DRAWN;
Chet Haase64a48c12012-02-13 16:33:29 -080013062
Romain Guyfbb43212012-08-30 15:19:27 -070013063 if (!concatMatrix &&
13064 (flags & (ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS |
13065 ViewGroup.FLAG_CLIP_CHILDREN)) == ViewGroup.FLAG_CLIP_CHILDREN &&
Chet Haase599913d2012-07-23 16:22:05 -070013066 canvas.quickReject(mLeft, mTop, mRight, mBottom, Canvas.EdgeType.BW) &&
Dianne Hackborn4702a852012-08-17 15:18:29 -070013067 (mPrivateFlags & PFLAG_DRAW_ANIMATION) == 0) {
13068 mPrivateFlags2 |= PFLAG2_VIEW_QUICK_REJECTED;
Chet Haase64a48c12012-02-13 16:33:29 -080013069 return more;
13070 }
Dianne Hackborn4702a852012-08-17 15:18:29 -070013071 mPrivateFlags2 &= ~PFLAG2_VIEW_QUICK_REJECTED;
Chet Haase64a48c12012-02-13 16:33:29 -080013072
13073 if (hardwareAccelerated) {
13074 // Clear INVALIDATED flag to allow invalidation to occur during rendering, but
13075 // retain the flag's value temporarily in the mRecreateDisplayList flag
Dianne Hackborn4702a852012-08-17 15:18:29 -070013076 mRecreateDisplayList = (mPrivateFlags & PFLAG_INVALIDATED) == PFLAG_INVALIDATED;
13077 mPrivateFlags &= ~PFLAG_INVALIDATED;
Chet Haase64a48c12012-02-13 16:33:29 -080013078 }
13079
Chet Haase64a48c12012-02-13 16:33:29 -080013080 DisplayList displayList = null;
13081 Bitmap cache = null;
13082 boolean hasDisplayList = false;
13083 if (caching) {
13084 if (!hardwareAccelerated) {
13085 if (layerType != LAYER_TYPE_NONE) {
13086 layerType = LAYER_TYPE_SOFTWARE;
13087 buildDrawingCache(true);
13088 }
13089 cache = getDrawingCache(true);
13090 } else {
13091 switch (layerType) {
13092 case LAYER_TYPE_SOFTWARE:
Chet Haaseb85967b2012-03-26 14:37:51 -070013093 if (useDisplayListProperties) {
13094 hasDisplayList = canHaveDisplayList();
13095 } else {
13096 buildDrawingCache(true);
13097 cache = getDrawingCache(true);
13098 }
Chet Haase64a48c12012-02-13 16:33:29 -080013099 break;
Chet Haasea1cff502012-02-21 13:43:44 -080013100 case LAYER_TYPE_HARDWARE:
13101 if (useDisplayListProperties) {
13102 hasDisplayList = canHaveDisplayList();
13103 }
13104 break;
Chet Haase64a48c12012-02-13 16:33:29 -080013105 case LAYER_TYPE_NONE:
13106 // Delay getting the display list until animation-driven alpha values are
13107 // set up and possibly passed on to the view
13108 hasDisplayList = canHaveDisplayList();
13109 break;
13110 }
13111 }
13112 }
Chet Haasea1cff502012-02-21 13:43:44 -080013113 useDisplayListProperties &= hasDisplayList;
Chet Haase9420abd2012-03-29 16:28:32 -070013114 if (useDisplayListProperties) {
13115 displayList = getDisplayList();
13116 if (!displayList.isValid()) {
13117 // Uncommon, but possible. If a view is removed from the hierarchy during the call
13118 // to getDisplayList(), the display list will be marked invalid and we should not
13119 // try to use it again.
13120 displayList = null;
13121 hasDisplayList = false;
13122 useDisplayListProperties = false;
13123 }
13124 }
Chet Haase64a48c12012-02-13 16:33:29 -080013125
Chet Haase526057b2012-07-12 17:50:41 -070013126 int sx = 0;
13127 int sy = 0;
13128 if (!hasDisplayList) {
13129 computeScroll();
13130 sx = mScrollX;
13131 sy = mScrollY;
13132 }
13133
Chet Haase64a48c12012-02-13 16:33:29 -080013134 final boolean hasNoCache = cache == null || hasDisplayList;
13135 final boolean offsetForScroll = cache == null && !hasDisplayList &&
13136 layerType != LAYER_TYPE_HARDWARE;
13137
Chet Haasea1cff502012-02-21 13:43:44 -080013138 int restoreTo = -1;
Chet Haase89b7f2e2012-03-21 11:15:37 -070013139 if (!useDisplayListProperties || transformToApply != null) {
Chet Haasea1cff502012-02-21 13:43:44 -080013140 restoreTo = canvas.save();
13141 }
Chet Haase64a48c12012-02-13 16:33:29 -080013142 if (offsetForScroll) {
Chet Haasebcca79a2012-02-14 08:45:14 -080013143 canvas.translate(mLeft - sx, mTop - sy);
Chet Haase64a48c12012-02-13 16:33:29 -080013144 } else {
Chet Haasea1cff502012-02-21 13:43:44 -080013145 if (!useDisplayListProperties) {
13146 canvas.translate(mLeft, mTop);
13147 }
Chet Haase64a48c12012-02-13 16:33:29 -080013148 if (scalingRequired) {
Chet Haasea1cff502012-02-21 13:43:44 -080013149 if (useDisplayListProperties) {
Chet Haase9420abd2012-03-29 16:28:32 -070013150 // TODO: Might not need this if we put everything inside the DL
Chet Haasea1cff502012-02-21 13:43:44 -080013151 restoreTo = canvas.save();
13152 }
Chet Haase64a48c12012-02-13 16:33:29 -080013153 // mAttachInfo cannot be null, otherwise scalingRequired == false
13154 final float scale = 1.0f / mAttachInfo.mApplicationScale;
13155 canvas.scale(scale, scale);
13156 }
13157 }
13158
Chet Haasea1cff502012-02-21 13:43:44 -080013159 float alpha = useDisplayListProperties ? 1 : getAlpha();
Chet Haase21433372012-06-05 07:54:09 -070013160 if (transformToApply != null || alpha < 1 || !hasIdentityMatrix() ||
Dianne Hackborn4702a852012-08-17 15:18:29 -070013161 (mPrivateFlags3 & PFLAG3_VIEW_IS_ANIMATING_ALPHA) == PFLAG3_VIEW_IS_ANIMATING_ALPHA) {
Chet Haase64a48c12012-02-13 16:33:29 -080013162 if (transformToApply != null || !childHasIdentityMatrix) {
13163 int transX = 0;
13164 int transY = 0;
13165
13166 if (offsetForScroll) {
13167 transX = -sx;
13168 transY = -sy;
13169 }
13170
13171 if (transformToApply != null) {
13172 if (concatMatrix) {
Chet Haase9420abd2012-03-29 16:28:32 -070013173 if (useDisplayListProperties) {
13174 displayList.setAnimationMatrix(transformToApply.getMatrix());
13175 } else {
13176 // Undo the scroll translation, apply the transformation matrix,
13177 // then redo the scroll translate to get the correct result.
13178 canvas.translate(-transX, -transY);
13179 canvas.concat(transformToApply.getMatrix());
13180 canvas.translate(transX, transY);
13181 }
Chet Haasea1cff502012-02-21 13:43:44 -080013182 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080013183 }
13184
13185 float transformAlpha = transformToApply.getAlpha();
Chet Haase9420abd2012-03-29 16:28:32 -070013186 if (transformAlpha < 1) {
Chet Haase21433372012-06-05 07:54:09 -070013187 alpha *= transformAlpha;
Chet Haasea1cff502012-02-21 13:43:44 -080013188 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080013189 }
13190 }
13191
Chet Haasea1cff502012-02-21 13:43:44 -080013192 if (!childHasIdentityMatrix && !useDisplayListProperties) {
Chet Haase64a48c12012-02-13 16:33:29 -080013193 canvas.translate(-transX, -transY);
13194 canvas.concat(getMatrix());
13195 canvas.translate(transX, transY);
13196 }
13197 }
13198
Chet Haase21433372012-06-05 07:54:09 -070013199 // Deal with alpha if it is or used to be <1
13200 if (alpha < 1 ||
Dianne Hackborn4702a852012-08-17 15:18:29 -070013201 (mPrivateFlags3 & PFLAG3_VIEW_IS_ANIMATING_ALPHA) == PFLAG3_VIEW_IS_ANIMATING_ALPHA) {
Chet Haase21433372012-06-05 07:54:09 -070013202 if (alpha < 1) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070013203 mPrivateFlags3 |= PFLAG3_VIEW_IS_ANIMATING_ALPHA;
Chet Haase21433372012-06-05 07:54:09 -070013204 } else {
Dianne Hackborn4702a852012-08-17 15:18:29 -070013205 mPrivateFlags3 &= ~PFLAG3_VIEW_IS_ANIMATING_ALPHA;
Chet Haase21433372012-06-05 07:54:09 -070013206 }
Chet Haasea1cff502012-02-21 13:43:44 -080013207 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080013208 if (hasNoCache) {
13209 final int multipliedAlpha = (int) (255 * alpha);
13210 if (!onSetAlpha(multipliedAlpha)) {
13211 int layerFlags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
Chet Haasea1cff502012-02-21 13:43:44 -080013212 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) != 0 ||
Chet Haase64a48c12012-02-13 16:33:29 -080013213 layerType != LAYER_TYPE_NONE) {
13214 layerFlags |= Canvas.CLIP_TO_LAYER_SAVE_FLAG;
13215 }
Chet Haase9420abd2012-03-29 16:28:32 -070013216 if (useDisplayListProperties) {
13217 displayList.setAlpha(alpha * getAlpha());
13218 } else if (layerType == LAYER_TYPE_NONE) {
Chet Haase89b7f2e2012-03-21 11:15:37 -070013219 final int scrollX = hasDisplayList ? 0 : sx;
13220 final int scrollY = hasDisplayList ? 0 : sy;
13221 canvas.saveLayerAlpha(scrollX, scrollY, scrollX + mRight - mLeft,
13222 scrollY + mBottom - mTop, multipliedAlpha, layerFlags);
Chet Haase64a48c12012-02-13 16:33:29 -080013223 }
13224 } else {
13225 // Alpha is handled by the child directly, clobber the layer's alpha
Dianne Hackborn4702a852012-08-17 15:18:29 -070013226 mPrivateFlags |= PFLAG_ALPHA_SET;
Chet Haase64a48c12012-02-13 16:33:29 -080013227 }
13228 }
13229 }
Dianne Hackborn4702a852012-08-17 15:18:29 -070013230 } else if ((mPrivateFlags & PFLAG_ALPHA_SET) == PFLAG_ALPHA_SET) {
Chet Haase64a48c12012-02-13 16:33:29 -080013231 onSetAlpha(255);
Dianne Hackborn4702a852012-08-17 15:18:29 -070013232 mPrivateFlags &= ~PFLAG_ALPHA_SET;
Chet Haase64a48c12012-02-13 16:33:29 -080013233 }
13234
Chet Haasea1cff502012-02-21 13:43:44 -080013235 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) == ViewGroup.FLAG_CLIP_CHILDREN &&
13236 !useDisplayListProperties) {
Chet Haase64a48c12012-02-13 16:33:29 -080013237 if (offsetForScroll) {
Chet Haasebcca79a2012-02-14 08:45:14 -080013238 canvas.clipRect(sx, sy, sx + (mRight - mLeft), sy + (mBottom - mTop));
Chet Haase64a48c12012-02-13 16:33:29 -080013239 } else {
13240 if (!scalingRequired || cache == null) {
Chet Haasebcca79a2012-02-14 08:45:14 -080013241 canvas.clipRect(0, 0, mRight - mLeft, mBottom - mTop);
Chet Haase64a48c12012-02-13 16:33:29 -080013242 } else {
13243 canvas.clipRect(0, 0, cache.getWidth(), cache.getHeight());
13244 }
13245 }
13246 }
13247
Chet Haase9420abd2012-03-29 16:28:32 -070013248 if (!useDisplayListProperties && hasDisplayList) {
Chet Haase64a48c12012-02-13 16:33:29 -080013249 displayList = getDisplayList();
13250 if (!displayList.isValid()) {
13251 // Uncommon, but possible. If a view is removed from the hierarchy during the call
13252 // to getDisplayList(), the display list will be marked invalid and we should not
13253 // try to use it again.
13254 displayList = null;
13255 hasDisplayList = false;
13256 }
13257 }
13258
13259 if (hasNoCache) {
13260 boolean layerRendered = false;
Chet Haasea1cff502012-02-21 13:43:44 -080013261 if (layerType == LAYER_TYPE_HARDWARE && !useDisplayListProperties) {
Michael Jurka7e52caf2012-03-06 15:57:06 -080013262 final HardwareLayer layer = getHardwareLayer();
Chet Haase64a48c12012-02-13 16:33:29 -080013263 if (layer != null && layer.isValid()) {
13264 mLayerPaint.setAlpha((int) (alpha * 255));
13265 ((HardwareCanvas) canvas).drawHardwareLayer(layer, 0, 0, mLayerPaint);
13266 layerRendered = true;
13267 } else {
13268 final int scrollX = hasDisplayList ? 0 : sx;
13269 final int scrollY = hasDisplayList ? 0 : sy;
13270 canvas.saveLayer(scrollX, scrollY,
Chet Haasebcca79a2012-02-14 08:45:14 -080013271 scrollX + mRight - mLeft, scrollY + mBottom - mTop, mLayerPaint,
Chet Haase64a48c12012-02-13 16:33:29 -080013272 Canvas.HAS_ALPHA_LAYER_SAVE_FLAG | Canvas.CLIP_TO_LAYER_SAVE_FLAG);
13273 }
13274 }
13275
13276 if (!layerRendered) {
13277 if (!hasDisplayList) {
13278 // Fast path for layouts with no backgrounds
Dianne Hackborn4702a852012-08-17 15:18:29 -070013279 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) {
13280 mPrivateFlags &= ~PFLAG_DIRTY_MASK;
Chet Haase64a48c12012-02-13 16:33:29 -080013281 dispatchDraw(canvas);
13282 } else {
13283 draw(canvas);
13284 }
13285 } else {
Dianne Hackborn4702a852012-08-17 15:18:29 -070013286 mPrivateFlags &= ~PFLAG_DIRTY_MASK;
Chet Haase1271e2c2012-04-20 09:54:27 -070013287 ((HardwareCanvas) canvas).drawDisplayList(displayList, null, flags);
Chet Haase64a48c12012-02-13 16:33:29 -080013288 }
13289 }
13290 } else if (cache != null) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070013291 mPrivateFlags &= ~PFLAG_DIRTY_MASK;
Chet Haase64a48c12012-02-13 16:33:29 -080013292 Paint cachePaint;
13293
13294 if (layerType == LAYER_TYPE_NONE) {
13295 cachePaint = parent.mCachePaint;
13296 if (cachePaint == null) {
13297 cachePaint = new Paint();
13298 cachePaint.setDither(false);
13299 parent.mCachePaint = cachePaint;
13300 }
Chet Haase9420abd2012-03-29 16:28:32 -070013301 if (alpha < 1) {
Chet Haase64a48c12012-02-13 16:33:29 -080013302 cachePaint.setAlpha((int) (alpha * 255));
Chet Haasea1cff502012-02-21 13:43:44 -080013303 parent.mGroupFlags |= ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE;
13304 } else if ((flags & ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE) != 0) {
Chet Haase64a48c12012-02-13 16:33:29 -080013305 cachePaint.setAlpha(255);
Chet Haasea1cff502012-02-21 13:43:44 -080013306 parent.mGroupFlags &= ~ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE;
Chet Haase64a48c12012-02-13 16:33:29 -080013307 }
13308 } else {
13309 cachePaint = mLayerPaint;
13310 cachePaint.setAlpha((int) (alpha * 255));
13311 }
13312 canvas.drawBitmap(cache, 0.0f, 0.0f, cachePaint);
13313 }
13314
Chet Haasea1cff502012-02-21 13:43:44 -080013315 if (restoreTo >= 0) {
13316 canvas.restoreToCount(restoreTo);
13317 }
Chet Haase64a48c12012-02-13 16:33:29 -080013318
13319 if (a != null && !more) {
13320 if (!hardwareAccelerated && !a.getFillAfter()) {
13321 onSetAlpha(255);
13322 }
13323 parent.finishAnimatingView(this, a);
13324 }
13325
13326 if (more && hardwareAccelerated) {
13327 // invalidation is the trigger to recreate display lists, so if we're using
13328 // display lists to render, force an invalidate to allow the animation to
13329 // continue drawing another frame
13330 parent.invalidate(true);
Dianne Hackborn4702a852012-08-17 15:18:29 -070013331 if (a.hasAlpha() && (mPrivateFlags & PFLAG_ALPHA_SET) == PFLAG_ALPHA_SET) {
Chet Haase64a48c12012-02-13 16:33:29 -080013332 // alpha animations should cause the child to recreate its display list
13333 invalidate(true);
13334 }
13335 }
13336
13337 mRecreateDisplayList = false;
13338
13339 return more;
13340 }
13341
13342 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013343 * Manually render this view (and all of its children) to the given Canvas.
13344 * The view must have already done a full layout before this function is
Romain Guy5c22a8c2011-05-13 11:48:45 -070013345 * called. When implementing a view, implement
13346 * {@link #onDraw(android.graphics.Canvas)} instead of overriding this method.
13347 * If you do need to override this method, call the superclass version.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013348 *
13349 * @param canvas The Canvas to which the View is rendered.
13350 */
13351 public void draw(Canvas canvas) {
Romain Guy5bcdff42009-05-14 21:27:18 -070013352 final int privateFlags = mPrivateFlags;
Dianne Hackborn4702a852012-08-17 15:18:29 -070013353 final boolean dirtyOpaque = (privateFlags & PFLAG_DIRTY_MASK) == PFLAG_DIRTY_OPAQUE &&
Romain Guy5bcdff42009-05-14 21:27:18 -070013354 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState);
Dianne Hackborn4702a852012-08-17 15:18:29 -070013355 mPrivateFlags = (privateFlags & ~PFLAG_DIRTY_MASK) | PFLAG_DRAWN;
Romain Guy24443ea2009-05-11 11:56:30 -070013356
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013357 /*
13358 * Draw traversal performs several drawing steps which must be executed
13359 * in the appropriate order:
13360 *
13361 * 1. Draw the background
13362 * 2. If necessary, save the canvas' layers to prepare for fading
13363 * 3. Draw view's content
13364 * 4. Draw children
13365 * 5. If necessary, draw the fading edges and restore layers
13366 * 6. Draw decorations (scrollbars for instance)
13367 */
13368
13369 // Step 1, draw the background, if needed
13370 int saveCount;
13371
Romain Guy24443ea2009-05-11 11:56:30 -070013372 if (!dirtyOpaque) {
Philip Milne6c8ea062012-04-03 17:38:43 -070013373 final Drawable background = mBackground;
Romain Guy24443ea2009-05-11 11:56:30 -070013374 if (background != null) {
13375 final int scrollX = mScrollX;
13376 final int scrollY = mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013377
Romain Guy24443ea2009-05-11 11:56:30 -070013378 if (mBackgroundSizeChanged) {
13379 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop);
13380 mBackgroundSizeChanged = false;
13381 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013382
Romain Guy24443ea2009-05-11 11:56:30 -070013383 if ((scrollX | scrollY) == 0) {
13384 background.draw(canvas);
13385 } else {
13386 canvas.translate(scrollX, scrollY);
13387 background.draw(canvas);
13388 canvas.translate(-scrollX, -scrollY);
13389 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013390 }
13391 }
13392
13393 // skip step 2 & 5 if possible (common case)
13394 final int viewFlags = mViewFlags;
13395 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0;
13396 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0;
13397 if (!verticalEdges && !horizontalEdges) {
13398 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -070013399 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013400
13401 // Step 4, draw the children
13402 dispatchDraw(canvas);
13403
13404 // Step 6, draw decorations (scrollbars)
13405 onDrawScrollBars(canvas);
13406
13407 // we're done...
13408 return;
13409 }
13410
13411 /*
13412 * Here we do the full fledged routine...
13413 * (this is an uncommon case where speed matters less,
13414 * this is why we repeat some of the tests that have been
13415 * done above)
13416 */
13417
13418 boolean drawTop = false;
13419 boolean drawBottom = false;
13420 boolean drawLeft = false;
13421 boolean drawRight = false;
13422
13423 float topFadeStrength = 0.0f;
13424 float bottomFadeStrength = 0.0f;
13425 float leftFadeStrength = 0.0f;
13426 float rightFadeStrength = 0.0f;
13427
13428 // Step 2, save the canvas' layers
13429 int paddingLeft = mPaddingLeft;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013430
13431 final boolean offsetRequired = isPaddingOffsetRequired();
13432 if (offsetRequired) {
13433 paddingLeft += getLeftPaddingOffset();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013434 }
13435
13436 int left = mScrollX + paddingLeft;
13437 int right = left + mRight - mLeft - mPaddingRight - paddingLeft;
Romain Guyf2fc4602011-07-19 15:20:03 -070013438 int top = mScrollY + getFadeTop(offsetRequired);
13439 int bottom = top + getFadeHeight(offsetRequired);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013440
13441 if (offsetRequired) {
13442 right += getRightPaddingOffset();
13443 bottom += getBottomPaddingOffset();
13444 }
13445
13446 final ScrollabilityCache scrollabilityCache = mScrollCache;
Philip Milne6c8ea062012-04-03 17:38:43 -070013447 final float fadeHeight = scrollabilityCache.fadingEdgeLength;
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013448 int length = (int) fadeHeight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013449
13450 // clip the fade length if top and bottom fades overlap
13451 // overlapping fades produce odd-looking artifacts
13452 if (verticalEdges && (top + length > bottom - length)) {
13453 length = (bottom - top) / 2;
13454 }
13455
13456 // also clip horizontal fades if necessary
13457 if (horizontalEdges && (left + length > right - length)) {
13458 length = (right - left) / 2;
13459 }
13460
13461 if (verticalEdges) {
13462 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013463 drawTop = topFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013464 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013465 drawBottom = bottomFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013466 }
13467
13468 if (horizontalEdges) {
13469 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013470 drawLeft = leftFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013471 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013472 drawRight = rightFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013473 }
13474
13475 saveCount = canvas.getSaveCount();
13476
13477 int solidColor = getSolidColor();
Romain Guyf607bdc2010-09-10 19:20:06 -070013478 if (solidColor == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013479 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
13480
13481 if (drawTop) {
13482 canvas.saveLayer(left, top, right, top + length, null, flags);
13483 }
13484
13485 if (drawBottom) {
13486 canvas.saveLayer(left, bottom - length, right, bottom, null, flags);
13487 }
13488
13489 if (drawLeft) {
13490 canvas.saveLayer(left, top, left + length, bottom, null, flags);
13491 }
13492
13493 if (drawRight) {
13494 canvas.saveLayer(right - length, top, right, bottom, null, flags);
13495 }
13496 } else {
13497 scrollabilityCache.setFadeColor(solidColor);
13498 }
13499
13500 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -070013501 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013502
13503 // Step 4, draw the children
13504 dispatchDraw(canvas);
13505
13506 // Step 5, draw the fade effect and restore layers
13507 final Paint p = scrollabilityCache.paint;
13508 final Matrix matrix = scrollabilityCache.matrix;
13509 final Shader fade = scrollabilityCache.shader;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013510
13511 if (drawTop) {
13512 matrix.setScale(1, fadeHeight * topFadeStrength);
13513 matrix.postTranslate(left, top);
13514 fade.setLocalMatrix(matrix);
13515 canvas.drawRect(left, top, right, top + length, p);
13516 }
13517
13518 if (drawBottom) {
13519 matrix.setScale(1, fadeHeight * bottomFadeStrength);
13520 matrix.postRotate(180);
13521 matrix.postTranslate(left, bottom);
13522 fade.setLocalMatrix(matrix);
13523 canvas.drawRect(left, bottom - length, right, bottom, p);
13524 }
13525
13526 if (drawLeft) {
13527 matrix.setScale(1, fadeHeight * leftFadeStrength);
13528 matrix.postRotate(-90);
13529 matrix.postTranslate(left, top);
13530 fade.setLocalMatrix(matrix);
13531 canvas.drawRect(left, top, left + length, bottom, p);
13532 }
13533
13534 if (drawRight) {
13535 matrix.setScale(1, fadeHeight * rightFadeStrength);
13536 matrix.postRotate(90);
13537 matrix.postTranslate(right, top);
13538 fade.setLocalMatrix(matrix);
13539 canvas.drawRect(right - length, top, right, bottom, p);
13540 }
13541
13542 canvas.restoreToCount(saveCount);
13543
13544 // Step 6, draw decorations (scrollbars)
13545 onDrawScrollBars(canvas);
13546 }
13547
13548 /**
13549 * Override this if your view is known to always be drawn on top of a solid color background,
13550 * and needs to draw fading edges. Returning a non-zero color enables the view system to
13551 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha
13552 * should be set to 0xFF.
13553 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013554 * @see #setVerticalFadingEdgeEnabled(boolean)
13555 * @see #setHorizontalFadingEdgeEnabled(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013556 *
13557 * @return The known solid color background for this view, or 0 if the color may vary
13558 */
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013559 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013560 public int getSolidColor() {
13561 return 0;
13562 }
13563
13564 /**
13565 * Build a human readable string representation of the specified view flags.
13566 *
13567 * @param flags the view flags to convert to a string
13568 * @return a String representing the supplied flags
13569 */
13570 private static String printFlags(int flags) {
13571 String output = "";
13572 int numFlags = 0;
13573 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) {
13574 output += "TAKES_FOCUS";
13575 numFlags++;
13576 }
13577
13578 switch (flags & VISIBILITY_MASK) {
13579 case INVISIBLE:
13580 if (numFlags > 0) {
13581 output += " ";
13582 }
13583 output += "INVISIBLE";
13584 // USELESS HERE numFlags++;
13585 break;
13586 case GONE:
13587 if (numFlags > 0) {
13588 output += " ";
13589 }
13590 output += "GONE";
13591 // USELESS HERE numFlags++;
13592 break;
13593 default:
13594 break;
13595 }
13596 return output;
13597 }
13598
13599 /**
13600 * Build a human readable string representation of the specified private
13601 * view flags.
13602 *
13603 * @param privateFlags the private view flags to convert to a string
13604 * @return a String representing the supplied flags
13605 */
13606 private static String printPrivateFlags(int privateFlags) {
13607 String output = "";
13608 int numFlags = 0;
13609
Dianne Hackborn4702a852012-08-17 15:18:29 -070013610 if ((privateFlags & PFLAG_WANTS_FOCUS) == PFLAG_WANTS_FOCUS) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013611 output += "WANTS_FOCUS";
13612 numFlags++;
13613 }
13614
Dianne Hackborn4702a852012-08-17 15:18:29 -070013615 if ((privateFlags & PFLAG_FOCUSED) == PFLAG_FOCUSED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013616 if (numFlags > 0) {
13617 output += " ";
13618 }
13619 output += "FOCUSED";
13620 numFlags++;
13621 }
13622
Dianne Hackborn4702a852012-08-17 15:18:29 -070013623 if ((privateFlags & PFLAG_SELECTED) == PFLAG_SELECTED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013624 if (numFlags > 0) {
13625 output += " ";
13626 }
13627 output += "SELECTED";
13628 numFlags++;
13629 }
13630
Dianne Hackborn4702a852012-08-17 15:18:29 -070013631 if ((privateFlags & PFLAG_IS_ROOT_NAMESPACE) == PFLAG_IS_ROOT_NAMESPACE) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013632 if (numFlags > 0) {
13633 output += " ";
13634 }
13635 output += "IS_ROOT_NAMESPACE";
13636 numFlags++;
13637 }
13638
Dianne Hackborn4702a852012-08-17 15:18:29 -070013639 if ((privateFlags & PFLAG_HAS_BOUNDS) == PFLAG_HAS_BOUNDS) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013640 if (numFlags > 0) {
13641 output += " ";
13642 }
13643 output += "HAS_BOUNDS";
13644 numFlags++;
13645 }
13646
Dianne Hackborn4702a852012-08-17 15:18:29 -070013647 if ((privateFlags & PFLAG_DRAWN) == PFLAG_DRAWN) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013648 if (numFlags > 0) {
13649 output += " ";
13650 }
13651 output += "DRAWN";
13652 // USELESS HERE numFlags++;
13653 }
13654 return output;
13655 }
13656
13657 /**
13658 * <p>Indicates whether or not this view's layout will be requested during
13659 * the next hierarchy layout pass.</p>
13660 *
13661 * @return true if the layout will be forced during next layout pass
13662 */
13663 public boolean isLayoutRequested() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070013664 return (mPrivateFlags & PFLAG_FORCE_LAYOUT) == PFLAG_FORCE_LAYOUT;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013665 }
13666
13667 /**
13668 * Assign a size and position to a view and all of its
13669 * descendants
13670 *
13671 * <p>This is the second phase of the layout mechanism.
13672 * (The first is measuring). In this phase, each parent calls
13673 * layout on all of its children to position them.
13674 * This is typically done using the child measurements
Chet Haase9c087442011-01-12 16:20:16 -080013675 * that were stored in the measure pass().</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013676 *
Chet Haase9c087442011-01-12 16:20:16 -080013677 * <p>Derived classes should not override this method.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013678 * Derived classes with children should override
13679 * onLayout. In that method, they should
Chet Haase9c087442011-01-12 16:20:16 -080013680 * call layout on each of their children.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013681 *
13682 * @param l Left position, relative to parent
13683 * @param t Top position, relative to parent
13684 * @param r Right position, relative to parent
13685 * @param b Bottom position, relative to parent
13686 */
Romain Guy5429e1d2010-09-07 12:38:00 -070013687 @SuppressWarnings({"unchecked"})
Chet Haase9c087442011-01-12 16:20:16 -080013688 public void layout(int l, int t, int r, int b) {
Chet Haase21cd1382010-09-01 17:42:29 -070013689 int oldL = mLeft;
13690 int oldT = mTop;
13691 int oldB = mBottom;
13692 int oldR = mRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013693 boolean changed = setFrame(l, t, r, b);
Dianne Hackborn4702a852012-08-17 15:18:29 -070013694 if (changed || (mPrivateFlags & PFLAG_LAYOUT_REQUIRED) == PFLAG_LAYOUT_REQUIRED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013695 onLayout(changed, l, t, r, b);
Dianne Hackborn4702a852012-08-17 15:18:29 -070013696 mPrivateFlags &= ~PFLAG_LAYOUT_REQUIRED;
Chet Haase21cd1382010-09-01 17:42:29 -070013697
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070013698 ListenerInfo li = mListenerInfo;
13699 if (li != null && li.mOnLayoutChangeListeners != null) {
Chet Haase21cd1382010-09-01 17:42:29 -070013700 ArrayList<OnLayoutChangeListener> listenersCopy =
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070013701 (ArrayList<OnLayoutChangeListener>)li.mOnLayoutChangeListeners.clone();
Chet Haase21cd1382010-09-01 17:42:29 -070013702 int numListeners = listenersCopy.size();
13703 for (int i = 0; i < numListeners; ++i) {
Chet Haase7c608f22010-10-22 17:54:04 -070013704 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB);
Chet Haase21cd1382010-09-01 17:42:29 -070013705 }
13706 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013707 }
Dianne Hackborn4702a852012-08-17 15:18:29 -070013708 mPrivateFlags &= ~PFLAG_FORCE_LAYOUT;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013709 }
13710
13711 /**
13712 * Called from layout when this view should
13713 * assign a size and position to each of its children.
13714 *
13715 * Derived classes with children should override
13716 * this method and call layout on each of
Chet Haase21cd1382010-09-01 17:42:29 -070013717 * their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013718 * @param changed This is a new size or position for this view
13719 * @param left Left position, relative to parent
13720 * @param top Top position, relative to parent
13721 * @param right Right position, relative to parent
13722 * @param bottom Bottom position, relative to parent
13723 */
13724 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
13725 }
13726
13727 /**
13728 * Assign a size and position to this view.
13729 *
13730 * This is called from layout.
13731 *
13732 * @param left Left position, relative to parent
13733 * @param top Top position, relative to parent
13734 * @param right Right position, relative to parent
13735 * @param bottom Bottom position, relative to parent
13736 * @return true if the new size and position are different than the
13737 * previous ones
13738 * {@hide}
13739 */
13740 protected boolean setFrame(int left, int top, int right, int bottom) {
13741 boolean changed = false;
13742
13743 if (DBG) {
Mitsuru Oshima64f59342009-06-21 00:03:11 -070013744 Log.d("View", this + " View.setFrame(" + left + "," + top + ","
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013745 + right + "," + bottom + ")");
13746 }
13747
13748 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) {
13749 changed = true;
13750
13751 // Remember our drawn bit
Dianne Hackborn4702a852012-08-17 15:18:29 -070013752 int drawn = mPrivateFlags & PFLAG_DRAWN;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013753
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013754 int oldWidth = mRight - mLeft;
13755 int oldHeight = mBottom - mTop;
Chet Haase75755e22011-07-18 17:48:25 -070013756 int newWidth = right - left;
13757 int newHeight = bottom - top;
13758 boolean sizeChanged = (newWidth != oldWidth) || (newHeight != oldHeight);
13759
13760 // Invalidate our old position
13761 invalidate(sizeChanged);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013762
13763 mLeft = left;
13764 mTop = top;
13765 mRight = right;
13766 mBottom = bottom;
Chet Haase1271e2c2012-04-20 09:54:27 -070013767 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -080013768 mDisplayList.setLeftTopRightBottom(mLeft, mTop, mRight, mBottom);
13769 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013770
Dianne Hackborn4702a852012-08-17 15:18:29 -070013771 mPrivateFlags |= PFLAG_HAS_BOUNDS;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013772
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013773
Chet Haase75755e22011-07-18 17:48:25 -070013774 if (sizeChanged) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070013775 if ((mPrivateFlags & PFLAG_PIVOT_EXPLICITLY_SET) == 0) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -080013776 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -070013777 if (mTransformationInfo != null) {
13778 mTransformationInfo.mMatrixDirty = true;
13779 }
Chet Haase6c7ad5d2010-12-28 08:40:00 -080013780 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013781 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight);
13782 }
13783
13784 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) {
13785 // If we are visible, force the DRAWN bit to on so that
13786 // this invalidate will go through (at least to our parent).
13787 // This is because someone may have invalidated this view
Chet Haase6c7ad5d2010-12-28 08:40:00 -080013788 // before this call to setFrame came in, thereby clearing
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013789 // the DRAWN bit.
Dianne Hackborn4702a852012-08-17 15:18:29 -070013790 mPrivateFlags |= PFLAG_DRAWN;
Chet Haase75755e22011-07-18 17:48:25 -070013791 invalidate(sizeChanged);
Chet Haasef28595e2011-01-31 18:52:12 -080013792 // parent display list may need to be recreated based on a change in the bounds
13793 // of any child
13794 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013795 }
13796
13797 // Reset drawn bit to original value (invalidate turns it off)
13798 mPrivateFlags |= drawn;
13799
13800 mBackgroundSizeChanged = true;
13801 }
13802 return changed;
13803 }
13804
13805 /**
13806 * Finalize inflating a view from XML. This is called as the last phase
13807 * of inflation, after all child views have been added.
13808 *
13809 * <p>Even if the subclass overrides onFinishInflate, they should always be
13810 * sure to call the super method, so that we get called.
13811 */
13812 protected void onFinishInflate() {
13813 }
13814
13815 /**
13816 * Returns the resources associated with this view.
13817 *
13818 * @return Resources object.
13819 */
13820 public Resources getResources() {
13821 return mResources;
13822 }
13823
13824 /**
13825 * Invalidates the specified Drawable.
13826 *
13827 * @param drawable the drawable to invalidate
13828 */
13829 public void invalidateDrawable(Drawable drawable) {
13830 if (verifyDrawable(drawable)) {
13831 final Rect dirty = drawable.getBounds();
13832 final int scrollX = mScrollX;
13833 final int scrollY = mScrollY;
13834
13835 invalidate(dirty.left + scrollX, dirty.top + scrollY,
13836 dirty.right + scrollX, dirty.bottom + scrollY);
13837 }
13838 }
13839
13840 /**
13841 * Schedules an action on a drawable to occur at a specified time.
13842 *
13843 * @param who the recipient of the action
13844 * @param what the action to run on the drawable
13845 * @param when the time at which the action must occur. Uses the
13846 * {@link SystemClock#uptimeMillis} timebase.
13847 */
13848 public void scheduleDrawable(Drawable who, Runnable what, long when) {
Adam Powell37419d72011-11-10 11:32:09 -080013849 if (verifyDrawable(who) && what != null) {
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080013850 final long delay = when - SystemClock.uptimeMillis();
Adam Powell37419d72011-11-10 11:32:09 -080013851 if (mAttachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070013852 mAttachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed(
13853 Choreographer.CALLBACK_ANIMATION, what, who,
13854 Choreographer.subtractFrameDelay(delay));
Adam Powell37419d72011-11-10 11:32:09 -080013855 } else {
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080013856 ViewRootImpl.getRunQueue().postDelayed(what, delay);
Adam Powell37419d72011-11-10 11:32:09 -080013857 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013858 }
13859 }
13860
13861 /**
13862 * Cancels a scheduled action on a drawable.
13863 *
13864 * @param who the recipient of the action
13865 * @param what the action to cancel
13866 */
13867 public void unscheduleDrawable(Drawable who, Runnable what) {
Adam Powell37419d72011-11-10 11:32:09 -080013868 if (verifyDrawable(who) && what != null) {
13869 if (mAttachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070013870 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks(
13871 Choreographer.CALLBACK_ANIMATION, what, who);
Adam Powell37419d72011-11-10 11:32:09 -080013872 } else {
13873 ViewRootImpl.getRunQueue().removeCallbacks(what);
13874 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013875 }
13876 }
13877
13878 /**
13879 * Unschedule any events associated with the given Drawable. This can be
13880 * used when selecting a new Drawable into a view, so that the previous
13881 * one is completely unscheduled.
13882 *
13883 * @param who The Drawable to unschedule.
13884 *
13885 * @see #drawableStateChanged
13886 */
13887 public void unscheduleDrawable(Drawable who) {
Jeff Brown43ea54b2012-03-09 14:37:48 -080013888 if (mAttachInfo != null && who != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070013889 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks(
13890 Choreographer.CALLBACK_ANIMATION, null, who);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013891 }
13892 }
13893
Fabrice Di Meglioc0053222011-06-13 12:16:51 -070013894 /**
Fabrice Di Megliob03b4342012-06-04 12:55:30 -070013895 * Resolve the Drawables depending on the layout direction. This is implicitly supposing
13896 * that the View directionality can and will be resolved before its Drawables.
13897 *
13898 * Will call {@link View#onResolveDrawables} when resolution is done.
13899 */
13900 public void resolveDrawables() {
13901 if (mBackground != null) {
13902 mBackground.setLayoutDirection(getResolvedLayoutDirection());
13903 }
13904 onResolveDrawables(getResolvedLayoutDirection());
13905 }
13906
13907 /**
13908 * Called when layout direction has been resolved.
13909 *
13910 * The default implementation does nothing.
13911 *
13912 * @param layoutDirection The resolved layout direction.
13913 *
13914 * @see {@link #LAYOUT_DIRECTION_LTR}
13915 * @see {@link #LAYOUT_DIRECTION_RTL}
13916 */
13917 public void onResolveDrawables(int layoutDirection) {
Fabrice Di Meglio6a036402011-05-23 14:43:23 -070013918 }
13919
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013920 /**
13921 * If your view subclass is displaying its own Drawable objects, it should
13922 * override this function and return true for any Drawable it is
13923 * displaying. This allows animations for those drawables to be
13924 * scheduled.
13925 *
13926 * <p>Be sure to call through to the super class when overriding this
13927 * function.
13928 *
13929 * @param who The Drawable to verify. Return true if it is one you are
13930 * displaying, else return the result of calling through to the
13931 * super class.
13932 *
13933 * @return boolean If true than the Drawable is being displayed in the
13934 * view; else false and it is not allowed to animate.
13935 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013936 * @see #unscheduleDrawable(android.graphics.drawable.Drawable)
13937 * @see #drawableStateChanged()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013938 */
13939 protected boolean verifyDrawable(Drawable who) {
Philip Milne6c8ea062012-04-03 17:38:43 -070013940 return who == mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013941 }
13942
13943 /**
13944 * This function is called whenever the state of the view changes in such
13945 * a way that it impacts the state of drawables being shown.
13946 *
13947 * <p>Be sure to call through to the superclass when overriding this
13948 * function.
13949 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013950 * @see Drawable#setState(int[])
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013951 */
13952 protected void drawableStateChanged() {
Philip Milne6c8ea062012-04-03 17:38:43 -070013953 Drawable d = mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013954 if (d != null && d.isStateful()) {
13955 d.setState(getDrawableState());
13956 }
13957 }
13958
13959 /**
13960 * Call this to force a view to update its drawable state. This will cause
13961 * drawableStateChanged to be called on this view. Views that are interested
13962 * in the new state should call getDrawableState.
13963 *
13964 * @see #drawableStateChanged
13965 * @see #getDrawableState
13966 */
13967 public void refreshDrawableState() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070013968 mPrivateFlags |= PFLAG_DRAWABLE_STATE_DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013969 drawableStateChanged();
13970
13971 ViewParent parent = mParent;
13972 if (parent != null) {
13973 parent.childDrawableStateChanged(this);
13974 }
13975 }
13976
13977 /**
13978 * Return an array of resource IDs of the drawable states representing the
13979 * current state of the view.
13980 *
13981 * @return The current drawable state
13982 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013983 * @see Drawable#setState(int[])
13984 * @see #drawableStateChanged()
13985 * @see #onCreateDrawableState(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013986 */
13987 public final int[] getDrawableState() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070013988 if ((mDrawableState != null) && ((mPrivateFlags & PFLAG_DRAWABLE_STATE_DIRTY) == 0)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013989 return mDrawableState;
13990 } else {
13991 mDrawableState = onCreateDrawableState(0);
Dianne Hackborn4702a852012-08-17 15:18:29 -070013992 mPrivateFlags &= ~PFLAG_DRAWABLE_STATE_DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013993 return mDrawableState;
13994 }
13995 }
13996
13997 /**
13998 * Generate the new {@link android.graphics.drawable.Drawable} state for
13999 * this view. This is called by the view
14000 * system when the cached Drawable state is determined to be invalid. To
14001 * retrieve the current state, you should use {@link #getDrawableState}.
14002 *
14003 * @param extraSpace if non-zero, this is the number of extra entries you
14004 * would like in the returned array in which you can place your own
14005 * states.
14006 *
14007 * @return Returns an array holding the current {@link Drawable} state of
14008 * the view.
14009 *
Philip Milne6c8ea062012-04-03 17:38:43 -070014010 * @see #mergeDrawableStates(int[], int[])
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014011 */
14012 protected int[] onCreateDrawableState(int extraSpace) {
14013 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE &&
14014 mParent instanceof View) {
14015 return ((View) mParent).onCreateDrawableState(extraSpace);
14016 }
14017
14018 int[] drawableState;
14019
14020 int privateFlags = mPrivateFlags;
14021
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014022 int viewStateIndex = 0;
Dianne Hackborn4702a852012-08-17 15:18:29 -070014023 if ((privateFlags & PFLAG_PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014024 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED;
14025 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED;
Dianne Hackborn4702a852012-08-17 15:18:29 -070014026 if ((privateFlags & PFLAG_SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014027 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED;
Dianne Hackborn4702a852012-08-17 15:18:29 -070014028 if ((privateFlags & PFLAG_ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED;
Adam Powell5a7e94e2011-04-25 15:30:43 -070014029 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested &&
14030 HardwareRenderer.isAvailable()) {
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080014031 // This is set if HW acceleration is requested, even if the current
14032 // process doesn't allow it. This is just to allow app preview
14033 // windows to better match their app.
14034 viewStateIndex |= VIEW_STATE_ACCELERATED;
14035 }
Dianne Hackborn4702a852012-08-17 15:18:29 -070014036 if ((privateFlags & PFLAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_HOVERED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014037
Christopher Tate3d4bf172011-03-28 16:16:46 -070014038 final int privateFlags2 = mPrivateFlags2;
Dianne Hackborn4702a852012-08-17 15:18:29 -070014039 if ((privateFlags2 & PFLAG2_DRAG_CAN_ACCEPT) != 0) viewStateIndex |= VIEW_STATE_DRAG_CAN_ACCEPT;
14040 if ((privateFlags2 & PFLAG2_DRAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_DRAG_HOVERED;
Christopher Tate3d4bf172011-03-28 16:16:46 -070014041
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014042 drawableState = VIEW_STATE_SETS[viewStateIndex];
14043
14044 //noinspection ConstantIfStatement
14045 if (false) {
14046 Log.i("View", "drawableStateIndex=" + viewStateIndex);
14047 Log.i("View", toString()
Dianne Hackborn4702a852012-08-17 15:18:29 -070014048 + " pressed=" + ((privateFlags & PFLAG_PRESSED) != 0)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014049 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED)
14050 + " fo=" + hasFocus()
Dianne Hackborn4702a852012-08-17 15:18:29 -070014051 + " sl=" + ((privateFlags & PFLAG_SELECTED) != 0)
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014052 + " wf=" + hasWindowFocus()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014053 + ": " + Arrays.toString(drawableState));
14054 }
14055
14056 if (extraSpace == 0) {
14057 return drawableState;
14058 }
14059
14060 final int[] fullState;
14061 if (drawableState != null) {
14062 fullState = new int[drawableState.length + extraSpace];
14063 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length);
14064 } else {
14065 fullState = new int[extraSpace];
14066 }
14067
14068 return fullState;
14069 }
14070
14071 /**
14072 * Merge your own state values in <var>additionalState</var> into the base
14073 * state values <var>baseState</var> that were returned by
Romain Guy5c22a8c2011-05-13 11:48:45 -070014074 * {@link #onCreateDrawableState(int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014075 *
14076 * @param baseState The base state values returned by
Romain Guy5c22a8c2011-05-13 11:48:45 -070014077 * {@link #onCreateDrawableState(int)}, which will be modified to also hold your
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014078 * own additional state values.
14079 *
14080 * @param additionalState The additional state values you would like
14081 * added to <var>baseState</var>; this array is not modified.
14082 *
14083 * @return As a convenience, the <var>baseState</var> array you originally
14084 * passed into the function is returned.
14085 *
Philip Milne6c8ea062012-04-03 17:38:43 -070014086 * @see #onCreateDrawableState(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014087 */
14088 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) {
14089 final int N = baseState.length;
14090 int i = N - 1;
14091 while (i >= 0 && baseState[i] == 0) {
14092 i--;
14093 }
14094 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length);
14095 return baseState;
14096 }
14097
14098 /**
Dianne Hackborn079e2352010-10-18 17:02:43 -070014099 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()}
14100 * on all Drawable objects associated with this view.
14101 */
14102 public void jumpDrawablesToCurrentState() {
Philip Milne6c8ea062012-04-03 17:38:43 -070014103 if (mBackground != null) {
14104 mBackground.jumpToCurrentState();
Dianne Hackborn079e2352010-10-18 17:02:43 -070014105 }
14106 }
14107
14108 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014109 * Sets the background color for this view.
14110 * @param color the color of the background
14111 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +000014112 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014113 public void setBackgroundColor(int color) {
Philip Milne6c8ea062012-04-03 17:38:43 -070014114 if (mBackground instanceof ColorDrawable) {
14115 ((ColorDrawable) mBackground).setColor(color);
Romain Guy7d3082a2012-07-11 17:52:54 -070014116 computeOpaqueFlags();
Chet Haase70d4ba12010-10-06 09:46:45 -070014117 } else {
Philip Milne6c8ea062012-04-03 17:38:43 -070014118 setBackground(new ColorDrawable(color));
Chet Haase70d4ba12010-10-06 09:46:45 -070014119 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014120 }
14121
14122 /**
14123 * Set the background to a given resource. The resource should refer to
Wink Saville7cd88e12009-08-04 14:45:10 -070014124 * a Drawable object or 0 to remove the background.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014125 * @param resid The identifier of the resource.
Philip Milne6c8ea062012-04-03 17:38:43 -070014126 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014127 * @attr ref android.R.styleable#View_background
14128 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +000014129 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014130 public void setBackgroundResource(int resid) {
14131 if (resid != 0 && resid == mBackgroundResource) {
14132 return;
14133 }
14134
14135 Drawable d= null;
14136 if (resid != 0) {
14137 d = mResources.getDrawable(resid);
14138 }
Philip Milne6c8ea062012-04-03 17:38:43 -070014139 setBackground(d);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014140
14141 mBackgroundResource = resid;
14142 }
14143
14144 /**
14145 * Set the background to a given Drawable, or remove the background. If the
14146 * background has padding, this View's padding is set to the background's
14147 * padding. However, when a background is removed, this View's padding isn't
14148 * touched. If setting the padding is desired, please use
14149 * {@link #setPadding(int, int, int, int)}.
14150 *
Philip Milne6c8ea062012-04-03 17:38:43 -070014151 * @param background The Drawable to use as the background, or null to remove the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014152 * background
14153 */
Philip Milne6c8ea062012-04-03 17:38:43 -070014154 public void setBackground(Drawable background) {
Romain Guyeb378892012-04-12 11:33:14 -070014155 //noinspection deprecation
Philip Milne6c8ea062012-04-03 17:38:43 -070014156 setBackgroundDrawable(background);
14157 }
14158
14159 /**
14160 * @deprecated use {@link #setBackground(Drawable)} instead
14161 */
14162 @Deprecated
14163 public void setBackgroundDrawable(Drawable background) {
Romain Guy846a5332012-07-11 17:44:57 -070014164 computeOpaqueFlags();
14165
Philip Milne6c8ea062012-04-03 17:38:43 -070014166 if (background == mBackground) {
Adam Powell4d36ec12011-07-17 16:44:16 -070014167 return;
14168 }
14169
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014170 boolean requestLayout = false;
14171
14172 mBackgroundResource = 0;
14173
14174 /*
14175 * Regardless of whether we're setting a new background or not, we want
14176 * to clear the previous drawable.
14177 */
Philip Milne6c8ea062012-04-03 17:38:43 -070014178 if (mBackground != null) {
14179 mBackground.setCallback(null);
14180 unscheduleDrawable(mBackground);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014181 }
14182
Philip Milne6c8ea062012-04-03 17:38:43 -070014183 if (background != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014184 Rect padding = sThreadLocal.get();
14185 if (padding == null) {
14186 padding = new Rect();
14187 sThreadLocal.set(padding);
14188 }
Fabrice Di Megliob03b4342012-06-04 12:55:30 -070014189 background.setLayoutDirection(getResolvedLayoutDirection());
Philip Milne6c8ea062012-04-03 17:38:43 -070014190 if (background.getPadding(padding)) {
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -070014191 // Reset padding resolution
Dianne Hackborn4702a852012-08-17 15:18:29 -070014192 mPrivateFlags2 &= ~PFLAG2_PADDING_RESOLVED;
Fabrice Di Megliob03b4342012-06-04 12:55:30 -070014193 switch (background.getLayoutDirection()) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014194 case LAYOUT_DIRECTION_RTL:
Fabrice Di Meglio016456e2012-07-17 20:35:48 -070014195 internalSetPadding(padding.right, padding.top, padding.left, padding.bottom);
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014196 break;
14197 case LAYOUT_DIRECTION_LTR:
14198 default:
Fabrice Di Meglio016456e2012-07-17 20:35:48 -070014199 internalSetPadding(padding.left, padding.top, padding.right, padding.bottom);
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014200 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014201 }
14202
14203 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or
14204 // if it has a different minimum size, we should layout again
Philip Milne6c8ea062012-04-03 17:38:43 -070014205 if (mBackground == null || mBackground.getMinimumHeight() != background.getMinimumHeight() ||
14206 mBackground.getMinimumWidth() != background.getMinimumWidth()) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014207 requestLayout = true;
14208 }
14209
Philip Milne6c8ea062012-04-03 17:38:43 -070014210 background.setCallback(this);
14211 if (background.isStateful()) {
14212 background.setState(getDrawableState());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014213 }
Philip Milne6c8ea062012-04-03 17:38:43 -070014214 background.setVisible(getVisibility() == VISIBLE, false);
14215 mBackground = background;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014216
Dianne Hackborn4702a852012-08-17 15:18:29 -070014217 if ((mPrivateFlags & PFLAG_SKIP_DRAW) != 0) {
14218 mPrivateFlags &= ~PFLAG_SKIP_DRAW;
14219 mPrivateFlags |= PFLAG_ONLY_DRAWS_BACKGROUND;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014220 requestLayout = true;
14221 }
14222 } else {
14223 /* Remove the background */
Philip Milne6c8ea062012-04-03 17:38:43 -070014224 mBackground = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014225
Dianne Hackborn4702a852012-08-17 15:18:29 -070014226 if ((mPrivateFlags & PFLAG_ONLY_DRAWS_BACKGROUND) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014227 /*
14228 * This view ONLY drew the background before and we're removing
14229 * the background, so now it won't draw anything
14230 * (hence we SKIP_DRAW)
14231 */
Dianne Hackborn4702a852012-08-17 15:18:29 -070014232 mPrivateFlags &= ~PFLAG_ONLY_DRAWS_BACKGROUND;
14233 mPrivateFlags |= PFLAG_SKIP_DRAW;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014234 }
14235
14236 /*
14237 * When the background is set, we try to apply its padding to this
14238 * View. When the background is removed, we don't touch this View's
14239 * padding. This is noted in the Javadocs. Hence, we don't need to
14240 * requestLayout(), the invalidate() below is sufficient.
14241 */
14242
14243 // The old background's minimum size could have affected this
14244 // View's layout, so let's requestLayout
14245 requestLayout = true;
14246 }
14247
Romain Guy8f1344f52009-05-15 16:03:59 -070014248 computeOpaqueFlags();
14249
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014250 if (requestLayout) {
14251 requestLayout();
14252 }
14253
14254 mBackgroundSizeChanged = true;
Romain Guy0fd89bf2011-01-26 15:41:30 -080014255 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014256 }
14257
14258 /**
14259 * Gets the background drawable
Philip Milne6c8ea062012-04-03 17:38:43 -070014260 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014261 * @return The drawable used as the background for this view, if any.
Philip Milne6c8ea062012-04-03 17:38:43 -070014262 *
14263 * @see #setBackground(Drawable)
14264 *
14265 * @attr ref android.R.styleable#View_background
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014266 */
14267 public Drawable getBackground() {
Philip Milne6c8ea062012-04-03 17:38:43 -070014268 return mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014269 }
14270
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014271 /**
14272 * Sets the padding. The view may add on the space required to display
14273 * the scrollbars, depending on the style and visibility of the scrollbars.
14274 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop},
14275 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different
14276 * from the values set in this call.
14277 *
14278 * @attr ref android.R.styleable#View_padding
14279 * @attr ref android.R.styleable#View_paddingBottom
14280 * @attr ref android.R.styleable#View_paddingLeft
14281 * @attr ref android.R.styleable#View_paddingRight
14282 * @attr ref android.R.styleable#View_paddingTop
14283 * @param left the left padding in pixels
14284 * @param top the top padding in pixels
14285 * @param right the right padding in pixels
14286 * @param bottom the bottom padding in pixels
14287 */
14288 public void setPadding(int left, int top, int right, int bottom) {
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -070014289 // Reset padding resolution
Dianne Hackborn4702a852012-08-17 15:18:29 -070014290 mPrivateFlags2 &= ~PFLAG2_PADDING_RESOLVED;
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -070014291
Fabrice Di Meglio016456e2012-07-17 20:35:48 -070014292 mUserPaddingStart = UNDEFINED_PADDING;
14293 mUserPaddingEnd = UNDEFINED_PADDING;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014294
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014295 internalSetPadding(left, top, right, bottom);
14296 }
14297
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -070014298 /**
14299 * @hide
14300 */
14301 protected void internalSetPadding(int left, int top, int right, int bottom) {
Adam Powell20232d02010-12-08 21:08:53 -080014302 mUserPaddingLeft = left;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014303 mUserPaddingRight = right;
14304 mUserPaddingBottom = bottom;
14305
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014306 final int viewFlags = mViewFlags;
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014307 boolean changed = false;
Romain Guy8506ab42009-06-11 17:35:47 -070014308
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014309 // Common case is there are no scroll bars.
14310 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014311 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) {
Adam Powell20232d02010-12-08 21:08:53 -080014312 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014313 ? 0 : getVerticalScrollbarWidth();
Adam Powell20232d02010-12-08 21:08:53 -080014314 switch (mVerticalScrollbarPosition) {
14315 case SCROLLBAR_POSITION_DEFAULT:
Fabrice Di Meglioc91b6ca2012-06-22 14:51:15 -070014316 if (isLayoutRtl()) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014317 left += offset;
14318 } else {
14319 right += offset;
14320 }
14321 break;
Adam Powell20232d02010-12-08 21:08:53 -080014322 case SCROLLBAR_POSITION_RIGHT:
14323 right += offset;
14324 break;
14325 case SCROLLBAR_POSITION_LEFT:
14326 left += offset;
14327 break;
14328 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014329 }
Adam Powell20232d02010-12-08 21:08:53 -080014330 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014331 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0
14332 ? 0 : getHorizontalScrollbarHeight();
14333 }
14334 }
Romain Guy8506ab42009-06-11 17:35:47 -070014335
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014336 if (mPaddingLeft != left) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014337 changed = true;
14338 mPaddingLeft = left;
14339 }
14340 if (mPaddingTop != top) {
14341 changed = true;
14342 mPaddingTop = top;
14343 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014344 if (mPaddingRight != right) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014345 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014346 mPaddingRight = right;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014347 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014348 if (mPaddingBottom != bottom) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014349 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014350 mPaddingBottom = bottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014351 }
14352
14353 if (changed) {
14354 requestLayout();
14355 }
14356 }
14357
14358 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014359 * Sets the relative padding. The view may add on the space required to display
14360 * the scrollbars, depending on the style and visibility of the scrollbars.
14361 * So the values returned from {@link #getPaddingStart}, {@link #getPaddingTop},
14362 * {@link #getPaddingEnd} and {@link #getPaddingBottom} may be different
14363 * from the values set in this call.
14364 *
14365 * @attr ref android.R.styleable#View_padding
14366 * @attr ref android.R.styleable#View_paddingBottom
14367 * @attr ref android.R.styleable#View_paddingStart
14368 * @attr ref android.R.styleable#View_paddingEnd
14369 * @attr ref android.R.styleable#View_paddingTop
14370 * @param start the start padding in pixels
14371 * @param top the top padding in pixels
14372 * @param end the end padding in pixels
14373 * @param bottom the bottom padding in pixels
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014374 */
14375 public void setPaddingRelative(int start, int top, int end, int bottom) {
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -070014376 // Reset padding resolution
Dianne Hackborn4702a852012-08-17 15:18:29 -070014377 mPrivateFlags2 &= ~PFLAG2_PADDING_RESOLVED;
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -070014378
Fabrice Di Megliof9e36502011-06-21 18:41:48 -070014379 mUserPaddingStart = start;
14380 mUserPaddingEnd = end;
14381
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014382 switch(getResolvedLayoutDirection()) {
14383 case LAYOUT_DIRECTION_RTL:
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014384 internalSetPadding(end, top, start, bottom);
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014385 break;
14386 case LAYOUT_DIRECTION_LTR:
14387 default:
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014388 internalSetPadding(start, top, end, bottom);
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014389 }
14390 }
14391
14392 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014393 * Returns the top padding of this view.
14394 *
14395 * @return the top padding in pixels
14396 */
14397 public int getPaddingTop() {
14398 return mPaddingTop;
14399 }
14400
14401 /**
14402 * Returns the bottom padding of this view. If there are inset and enabled
14403 * scrollbars, this value may include the space required to display the
14404 * scrollbars as well.
14405 *
14406 * @return the bottom padding in pixels
14407 */
14408 public int getPaddingBottom() {
14409 return mPaddingBottom;
14410 }
14411
14412 /**
14413 * Returns the left padding of this view. If there are inset and enabled
14414 * scrollbars, this value may include the space required to display the
14415 * scrollbars as well.
14416 *
14417 * @return the left padding in pixels
14418 */
14419 public int getPaddingLeft() {
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -070014420 if (!isPaddingResolved()) {
14421 resolvePadding();
14422 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014423 return mPaddingLeft;
14424 }
14425
14426 /**
Fabrice Di Meglio30a21e12012-03-12 13:12:19 -070014427 * Returns the start padding of this view depending on its resolved layout direction.
14428 * If there are inset and enabled scrollbars, this value may include the space
14429 * required to display the scrollbars as well.
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014430 *
14431 * @return the start padding in pixels
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014432 */
14433 public int getPaddingStart() {
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -070014434 if (!isPaddingResolved()) {
14435 resolvePadding();
14436 }
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014437 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) ?
14438 mPaddingRight : mPaddingLeft;
14439 }
14440
14441 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014442 * Returns the right padding of this view. If there are inset and enabled
14443 * scrollbars, this value may include the space required to display the
14444 * scrollbars as well.
14445 *
14446 * @return the right padding in pixels
14447 */
14448 public int getPaddingRight() {
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -070014449 if (!isPaddingResolved()) {
14450 resolvePadding();
14451 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014452 return mPaddingRight;
14453 }
14454
14455 /**
Fabrice Di Meglio30a21e12012-03-12 13:12:19 -070014456 * Returns the end padding of this view depending on its resolved layout direction.
14457 * If there are inset and enabled scrollbars, this value may include the space
14458 * required to display the scrollbars as well.
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014459 *
14460 * @return the end padding in pixels
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014461 */
14462 public int getPaddingEnd() {
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -070014463 if (!isPaddingResolved()) {
14464 resolvePadding();
14465 }
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014466 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) ?
14467 mPaddingLeft : mPaddingRight;
14468 }
14469
14470 /**
14471 * Return if the padding as been set thru relative values
14472 * {@link #setPaddingRelative(int, int, int, int)} or thru
14473 * @attr ref android.R.styleable#View_paddingStart or
14474 * @attr ref android.R.styleable#View_paddingEnd
14475 *
14476 * @return true if the padding is relative or false if it is not.
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014477 */
14478 public boolean isPaddingRelative() {
Fabrice Di Meglio016456e2012-07-17 20:35:48 -070014479 return (mUserPaddingStart != UNDEFINED_PADDING || mUserPaddingEnd != UNDEFINED_PADDING);
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014480 }
14481
14482 /**
Philip Milne1557fd72012-04-04 23:41:34 -070014483 * @hide
14484 */
Philip Milne7a23b492012-04-24 22:12:36 -070014485 public Insets getOpticalInsets() {
Philip Milne1557fd72012-04-04 23:41:34 -070014486 if (mLayoutInsets == null) {
Philip Milnebbd51f12012-04-18 15:09:05 -070014487 mLayoutInsets = (mBackground == null) ? Insets.NONE : mBackground.getLayoutInsets();
Philip Milne1557fd72012-04-04 23:41:34 -070014488 }
14489 return mLayoutInsets;
14490 }
14491
14492 /**
14493 * @hide
14494 */
14495 public void setLayoutInsets(Insets layoutInsets) {
14496 mLayoutInsets = layoutInsets;
14497 }
14498
14499 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014500 * Changes the selection state of this view. A view can be selected or not.
14501 * Note that selection is not the same as focus. Views are typically
14502 * selected in the context of an AdapterView like ListView or GridView;
14503 * the selected view is the view that is highlighted.
14504 *
14505 * @param selected true if the view must be selected, false otherwise
14506 */
14507 public void setSelected(boolean selected) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070014508 if (((mPrivateFlags & PFLAG_SELECTED) != 0) != selected) {
14509 mPrivateFlags = (mPrivateFlags & ~PFLAG_SELECTED) | (selected ? PFLAG_SELECTED : 0);
Romain Guya2431d02009-04-30 16:30:00 -070014510 if (!selected) resetPressedState();
Romain Guy0fd89bf2011-01-26 15:41:30 -080014511 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014512 refreshDrawableState();
14513 dispatchSetSelected(selected);
Svetoslav Ganov42138042012-03-20 11:51:39 -070014514 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
14515 notifyAccessibilityStateChanged();
14516 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014517 }
14518 }
14519
14520 /**
14521 * Dispatch setSelected to all of this View's children.
14522 *
14523 * @see #setSelected(boolean)
14524 *
14525 * @param selected The new selected state
14526 */
14527 protected void dispatchSetSelected(boolean selected) {
14528 }
14529
14530 /**
14531 * Indicates the selection state of this view.
14532 *
14533 * @return true if the view is selected, false otherwise
14534 */
14535 @ViewDebug.ExportedProperty
14536 public boolean isSelected() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070014537 return (mPrivateFlags & PFLAG_SELECTED) != 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014538 }
14539
14540 /**
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014541 * Changes the activated state of this view. A view can be activated or not.
14542 * Note that activation is not the same as selection. Selection is
14543 * a transient property, representing the view (hierarchy) the user is
14544 * currently interacting with. Activation is a longer-term state that the
14545 * user can move views in and out of. For example, in a list view with
14546 * single or multiple selection enabled, the views in the current selection
14547 * set are activated. (Um, yeah, we are deeply sorry about the terminology
14548 * here.) The activated state is propagated down to children of the view it
14549 * is set on.
14550 *
14551 * @param activated true if the view must be activated, false otherwise
14552 */
14553 public void setActivated(boolean activated) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070014554 if (((mPrivateFlags & PFLAG_ACTIVATED) != 0) != activated) {
14555 mPrivateFlags = (mPrivateFlags & ~PFLAG_ACTIVATED) | (activated ? PFLAG_ACTIVATED : 0);
Romain Guy0fd89bf2011-01-26 15:41:30 -080014556 invalidate(true);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014557 refreshDrawableState();
Dianne Hackbornc6669ca2010-09-16 01:33:24 -070014558 dispatchSetActivated(activated);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014559 }
14560 }
14561
14562 /**
14563 * Dispatch setActivated to all of this View's children.
14564 *
14565 * @see #setActivated(boolean)
14566 *
14567 * @param activated The new activated state
14568 */
14569 protected void dispatchSetActivated(boolean activated) {
14570 }
14571
14572 /**
14573 * Indicates the activation state of this view.
14574 *
14575 * @return true if the view is activated, false otherwise
14576 */
14577 @ViewDebug.ExportedProperty
14578 public boolean isActivated() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070014579 return (mPrivateFlags & PFLAG_ACTIVATED) != 0;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014580 }
14581
14582 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014583 * Returns the ViewTreeObserver for this view's hierarchy. The view tree
14584 * observer can be used to get notifications when global events, like
14585 * layout, happen.
14586 *
14587 * The returned ViewTreeObserver observer is not guaranteed to remain
14588 * valid for the lifetime of this View. If the caller of this method keeps
14589 * a long-lived reference to ViewTreeObserver, it should always check for
14590 * the return value of {@link ViewTreeObserver#isAlive()}.
14591 *
14592 * @return The ViewTreeObserver for this view's hierarchy.
14593 */
14594 public ViewTreeObserver getViewTreeObserver() {
14595 if (mAttachInfo != null) {
14596 return mAttachInfo.mTreeObserver;
14597 }
14598 if (mFloatingTreeObserver == null) {
14599 mFloatingTreeObserver = new ViewTreeObserver();
14600 }
14601 return mFloatingTreeObserver;
14602 }
14603
14604 /**
14605 * <p>Finds the topmost view in the current view hierarchy.</p>
14606 *
14607 * @return the topmost view containing this view
14608 */
14609 public View getRootView() {
14610 if (mAttachInfo != null) {
14611 final View v = mAttachInfo.mRootView;
14612 if (v != null) {
14613 return v;
14614 }
14615 }
Romain Guy8506ab42009-06-11 17:35:47 -070014616
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014617 View parent = this;
14618
14619 while (parent.mParent != null && parent.mParent instanceof View) {
14620 parent = (View) parent.mParent;
14621 }
14622
14623 return parent;
14624 }
14625
14626 /**
14627 * <p>Computes the coordinates of this view on the screen. The argument
14628 * must be an array of two integers. After the method returns, the array
14629 * contains the x and y location in that order.</p>
14630 *
14631 * @param location an array of two integers in which to hold the coordinates
14632 */
14633 public void getLocationOnScreen(int[] location) {
14634 getLocationInWindow(location);
14635
14636 final AttachInfo info = mAttachInfo;
Romain Guy779398e2009-06-16 13:17:50 -070014637 if (info != null) {
14638 location[0] += info.mWindowLeft;
14639 location[1] += info.mWindowTop;
14640 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014641 }
14642
14643 /**
14644 * <p>Computes the coordinates of this view in its window. The argument
14645 * must be an array of two integers. After the method returns, the array
14646 * contains the x and y location in that order.</p>
14647 *
14648 * @param location an array of two integers in which to hold the coordinates
14649 */
14650 public void getLocationInWindow(int[] location) {
14651 if (location == null || location.length < 2) {
Gilles Debunnecea45132011-11-24 02:19:27 +010014652 throw new IllegalArgumentException("location must be an array of two integers");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014653 }
14654
Gilles Debunne6583ce52011-12-06 18:09:02 -080014655 if (mAttachInfo == null) {
14656 // When the view is not attached to a window, this method does not make sense
14657 location[0] = location[1] = 0;
14658 return;
14659 }
14660
Gilles Debunnecea45132011-11-24 02:19:27 +010014661 float[] position = mAttachInfo.mTmpTransformLocation;
14662 position[0] = position[1] = 0.0f;
14663
14664 if (!hasIdentityMatrix()) {
14665 getMatrix().mapPoints(position);
Dianne Hackbornddb715b2011-09-09 14:43:39 -070014666 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014667
Gilles Debunnecea45132011-11-24 02:19:27 +010014668 position[0] += mLeft;
14669 position[1] += mTop;
14670
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014671 ViewParent viewParent = mParent;
14672 while (viewParent instanceof View) {
Gilles Debunnecea45132011-11-24 02:19:27 +010014673 final View view = (View) viewParent;
14674
14675 position[0] -= view.mScrollX;
14676 position[1] -= view.mScrollY;
14677
14678 if (!view.hasIdentityMatrix()) {
14679 view.getMatrix().mapPoints(position);
Dianne Hackbornddb715b2011-09-09 14:43:39 -070014680 }
Gilles Debunnecea45132011-11-24 02:19:27 +010014681
14682 position[0] += view.mLeft;
14683 position[1] += view.mTop;
14684
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014685 viewParent = view.mParent;
Svetoslav Ganov42138042012-03-20 11:51:39 -070014686 }
Romain Guy8506ab42009-06-11 17:35:47 -070014687
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070014688 if (viewParent instanceof ViewRootImpl) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014689 // *cough*
Gilles Debunnecea45132011-11-24 02:19:27 +010014690 final ViewRootImpl vr = (ViewRootImpl) viewParent;
14691 position[1] -= vr.mCurScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014692 }
Gilles Debunnecea45132011-11-24 02:19:27 +010014693
14694 location[0] = (int) (position[0] + 0.5f);
14695 location[1] = (int) (position[1] + 0.5f);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014696 }
14697
14698 /**
14699 * {@hide}
14700 * @param id the id of the view to be found
14701 * @return the view of the specified id, null if cannot be found
14702 */
14703 protected View findViewTraversal(int id) {
14704 if (id == mID) {
14705 return this;
14706 }
14707 return null;
14708 }
14709
14710 /**
14711 * {@hide}
14712 * @param tag the tag of the view to be found
14713 * @return the view of specified tag, null if cannot be found
14714 */
14715 protected View findViewWithTagTraversal(Object tag) {
14716 if (tag != null && tag.equals(mTag)) {
14717 return this;
14718 }
14719 return null;
14720 }
14721
14722 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -080014723 * {@hide}
14724 * @param predicate The predicate to evaluate.
Jeff Brown4dfbec22011-08-15 14:55:37 -070014725 * @param childToSkip If not null, ignores this child during the recursive traversal.
Jeff Brown4e6319b2010-12-13 10:36:51 -080014726 * @return The first view that matches the predicate or null.
14727 */
Jeff Brown4dfbec22011-08-15 14:55:37 -070014728 protected View findViewByPredicateTraversal(Predicate<View> predicate, View childToSkip) {
Jeff Brown4e6319b2010-12-13 10:36:51 -080014729 if (predicate.apply(this)) {
14730 return this;
14731 }
14732 return null;
14733 }
14734
14735 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014736 * Look for a child view with the given id. If this view has the given
14737 * id, return this view.
14738 *
14739 * @param id The id to search for.
14740 * @return The view that has the given id in the hierarchy or null
14741 */
14742 public final View findViewById(int id) {
14743 if (id < 0) {
14744 return null;
14745 }
14746 return findViewTraversal(id);
14747 }
14748
14749 /**
Svetoslav Ganov2cdedff2011-10-03 14:18:42 -070014750 * Finds a view by its unuque and stable accessibility id.
14751 *
14752 * @param accessibilityId The searched accessibility id.
14753 * @return The found view.
14754 */
14755 final View findViewByAccessibilityId(int accessibilityId) {
14756 if (accessibilityId < 0) {
14757 return null;
14758 }
14759 return findViewByAccessibilityIdTraversal(accessibilityId);
14760 }
14761
14762 /**
14763 * Performs the traversal to find a view by its unuque and stable accessibility id.
14764 *
14765 * <strong>Note:</strong>This method does not stop at the root namespace
14766 * boundary since the user can touch the screen at an arbitrary location
14767 * potentially crossing the root namespace bounday which will send an
14768 * accessibility event to accessibility services and they should be able
14769 * to obtain the event source. Also accessibility ids are guaranteed to be
14770 * unique in the window.
14771 *
14772 * @param accessibilityId The accessibility id.
14773 * @return The found view.
14774 */
14775 View findViewByAccessibilityIdTraversal(int accessibilityId) {
14776 if (getAccessibilityViewId() == accessibilityId) {
14777 return this;
14778 }
14779 return null;
14780 }
14781
14782 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014783 * Look for a child view with the given tag. If this view has the given
14784 * tag, return this view.
14785 *
14786 * @param tag The tag to search for, using "tag.equals(getTag())".
14787 * @return The View that has the given tag in the hierarchy or null
14788 */
14789 public final View findViewWithTag(Object tag) {
14790 if (tag == null) {
14791 return null;
14792 }
14793 return findViewWithTagTraversal(tag);
14794 }
14795
14796 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -080014797 * {@hide}
14798 * Look for a child view that matches the specified predicate.
14799 * If this view matches the predicate, return this view.
14800 *
14801 * @param predicate The predicate to evaluate.
14802 * @return The first view that matches the predicate or null.
14803 */
14804 public final View findViewByPredicate(Predicate<View> predicate) {
Jeff Brown4dfbec22011-08-15 14:55:37 -070014805 return findViewByPredicateTraversal(predicate, null);
14806 }
14807
14808 /**
14809 * {@hide}
14810 * Look for a child view that matches the specified predicate,
14811 * starting with the specified view and its descendents and then
14812 * recusively searching the ancestors and siblings of that view
14813 * until this view is reached.
14814 *
14815 * This method is useful in cases where the predicate does not match
14816 * a single unique view (perhaps multiple views use the same id)
14817 * and we are trying to find the view that is "closest" in scope to the
14818 * starting view.
14819 *
14820 * @param start The view to start from.
14821 * @param predicate The predicate to evaluate.
14822 * @return The first view that matches the predicate or null.
14823 */
14824 public final View findViewByPredicateInsideOut(View start, Predicate<View> predicate) {
14825 View childToSkip = null;
14826 for (;;) {
14827 View view = start.findViewByPredicateTraversal(predicate, childToSkip);
14828 if (view != null || start == this) {
14829 return view;
14830 }
14831
14832 ViewParent parent = start.getParent();
14833 if (parent == null || !(parent instanceof View)) {
14834 return null;
14835 }
14836
14837 childToSkip = start;
14838 start = (View) parent;
14839 }
Jeff Brown4e6319b2010-12-13 10:36:51 -080014840 }
14841
14842 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014843 * Sets the identifier for this view. The identifier does not have to be
14844 * unique in this view's hierarchy. The identifier should be a positive
14845 * number.
14846 *
14847 * @see #NO_ID
Philip Milne6c8ea062012-04-03 17:38:43 -070014848 * @see #getId()
14849 * @see #findViewById(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014850 *
14851 * @param id a number used to identify the view
14852 *
14853 * @attr ref android.R.styleable#View_id
14854 */
14855 public void setId(int id) {
14856 mID = id;
14857 }
14858
14859 /**
14860 * {@hide}
14861 *
14862 * @param isRoot true if the view belongs to the root namespace, false
14863 * otherwise
14864 */
14865 public void setIsRootNamespace(boolean isRoot) {
14866 if (isRoot) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070014867 mPrivateFlags |= PFLAG_IS_ROOT_NAMESPACE;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014868 } else {
Dianne Hackborn4702a852012-08-17 15:18:29 -070014869 mPrivateFlags &= ~PFLAG_IS_ROOT_NAMESPACE;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014870 }
14871 }
14872
14873 /**
14874 * {@hide}
14875 *
14876 * @return true if the view belongs to the root namespace, false otherwise
14877 */
14878 public boolean isRootNamespace() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070014879 return (mPrivateFlags&PFLAG_IS_ROOT_NAMESPACE) != 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014880 }
14881
14882 /**
14883 * Returns this view's identifier.
14884 *
14885 * @return a positive integer used to identify the view or {@link #NO_ID}
14886 * if the view has no ID
14887 *
Philip Milne6c8ea062012-04-03 17:38:43 -070014888 * @see #setId(int)
14889 * @see #findViewById(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014890 * @attr ref android.R.styleable#View_id
14891 */
14892 @ViewDebug.CapturedViewProperty
14893 public int getId() {
14894 return mID;
14895 }
14896
14897 /**
14898 * Returns this view's tag.
14899 *
14900 * @return the Object stored in this view as a tag
Romain Guyd90a3312009-05-06 14:54:28 -070014901 *
14902 * @see #setTag(Object)
14903 * @see #getTag(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014904 */
14905 @ViewDebug.ExportedProperty
14906 public Object getTag() {
14907 return mTag;
14908 }
14909
14910 /**
14911 * Sets the tag associated with this view. A tag can be used to mark
14912 * a view in its hierarchy and does not have to be unique within the
14913 * hierarchy. Tags can also be used to store data within a view without
14914 * resorting to another data structure.
14915 *
14916 * @param tag an Object to tag the view with
Romain Guyd90a3312009-05-06 14:54:28 -070014917 *
14918 * @see #getTag()
14919 * @see #setTag(int, Object)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014920 */
14921 public void setTag(final Object tag) {
14922 mTag = tag;
14923 }
14924
14925 /**
Romain Guyd90a3312009-05-06 14:54:28 -070014926 * Returns the tag associated with this view and the specified key.
14927 *
14928 * @param key The key identifying the tag
14929 *
14930 * @return the Object stored in this view as a tag
14931 *
14932 * @see #setTag(int, Object)
Romain Guy8506ab42009-06-11 17:35:47 -070014933 * @see #getTag()
Romain Guyd90a3312009-05-06 14:54:28 -070014934 */
14935 public Object getTag(int key) {
Adam Powell7db82ac2011-09-22 19:44:04 -070014936 if (mKeyedTags != null) return mKeyedTags.get(key);
Romain Guyd90a3312009-05-06 14:54:28 -070014937 return null;
14938 }
14939
14940 /**
14941 * Sets a tag associated with this view and a key. A tag can be used
14942 * to mark a view in its hierarchy and does not have to be unique within
14943 * the hierarchy. Tags can also be used to store data within a view
14944 * without resorting to another data structure.
14945 *
14946 * The specified key should be an id declared in the resources of the
Scott Maindfe5c202010-06-08 15:54:52 -070014947 * application to ensure it is unique (see the <a
14948 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>).
14949 * Keys identified as belonging to
Romain Guyd90a3312009-05-06 14:54:28 -070014950 * the Android framework or not associated with any package will cause
14951 * an {@link IllegalArgumentException} to be thrown.
14952 *
14953 * @param key The key identifying the tag
14954 * @param tag An Object to tag the view with
14955 *
14956 * @throws IllegalArgumentException If they specified key is not valid
14957 *
14958 * @see #setTag(Object)
14959 * @see #getTag(int)
14960 */
14961 public void setTag(int key, final Object tag) {
14962 // If the package id is 0x00 or 0x01, it's either an undefined package
14963 // or a framework id
14964 if ((key >>> 24) < 2) {
14965 throw new IllegalArgumentException("The key must be an application-specific "
14966 + "resource id.");
14967 }
14968
Adam Powell2b2f6d62011-09-23 11:15:39 -070014969 setKeyedTag(key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070014970 }
14971
14972 /**
14973 * Variation of {@link #setTag(int, Object)} that enforces the key to be a
14974 * framework id.
14975 *
14976 * @hide
14977 */
14978 public void setTagInternal(int key, Object tag) {
14979 if ((key >>> 24) != 0x1) {
14980 throw new IllegalArgumentException("The key must be a framework-specific "
14981 + "resource id.");
14982 }
14983
Adam Powell2b2f6d62011-09-23 11:15:39 -070014984 setKeyedTag(key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070014985 }
14986
Adam Powell2b2f6d62011-09-23 11:15:39 -070014987 private void setKeyedTag(int key, Object tag) {
Adam Powell7db82ac2011-09-22 19:44:04 -070014988 if (mKeyedTags == null) {
14989 mKeyedTags = new SparseArray<Object>();
Romain Guyd90a3312009-05-06 14:54:28 -070014990 }
14991
Adam Powell7db82ac2011-09-22 19:44:04 -070014992 mKeyedTags.put(key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070014993 }
14994
14995 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014996 * Prints information about this view in the log output, with the tag
14997 * {@link #VIEW_LOG_TAG}.
14998 *
14999 * @hide
15000 */
15001 public void debug() {
15002 debug(0);
15003 }
15004
15005 /**
15006 * Prints information about this view in the log output, with the tag
15007 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an
15008 * indentation defined by the <code>depth</code>.
15009 *
15010 * @param depth the indentation level
15011 *
15012 * @hide
15013 */
15014 protected void debug(int depth) {
15015 String output = debugIndent(depth - 1);
15016
15017 output += "+ " + this;
15018 int id = getId();
15019 if (id != -1) {
15020 output += " (id=" + id + ")";
15021 }
15022 Object tag = getTag();
15023 if (tag != null) {
15024 output += " (tag=" + tag + ")";
15025 }
15026 Log.d(VIEW_LOG_TAG, output);
15027
Dianne Hackborn4702a852012-08-17 15:18:29 -070015028 if ((mPrivateFlags & PFLAG_FOCUSED) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015029 output = debugIndent(depth) + " FOCUSED";
15030 Log.d(VIEW_LOG_TAG, output);
15031 }
15032
15033 output = debugIndent(depth);
15034 output += "frame={" + mLeft + ", " + mTop + ", " + mRight
15035 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY
15036 + "} ";
15037 Log.d(VIEW_LOG_TAG, output);
15038
15039 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0
15040 || mPaddingBottom != 0) {
15041 output = debugIndent(depth);
15042 output += "padding={" + mPaddingLeft + ", " + mPaddingTop
15043 + ", " + mPaddingRight + ", " + mPaddingBottom + "}";
15044 Log.d(VIEW_LOG_TAG, output);
15045 }
15046
15047 output = debugIndent(depth);
15048 output += "mMeasureWidth=" + mMeasuredWidth +
15049 " mMeasureHeight=" + mMeasuredHeight;
15050 Log.d(VIEW_LOG_TAG, output);
15051
15052 output = debugIndent(depth);
15053 if (mLayoutParams == null) {
15054 output += "BAD! no layout params";
15055 } else {
15056 output = mLayoutParams.debug(output);
15057 }
15058 Log.d(VIEW_LOG_TAG, output);
15059
15060 output = debugIndent(depth);
15061 output += "flags={";
15062 output += View.printFlags(mViewFlags);
15063 output += "}";
15064 Log.d(VIEW_LOG_TAG, output);
15065
15066 output = debugIndent(depth);
15067 output += "privateFlags={";
15068 output += View.printPrivateFlags(mPrivateFlags);
15069 output += "}";
15070 Log.d(VIEW_LOG_TAG, output);
15071 }
15072
15073 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +090015074 * Creates a string of whitespaces used for indentation.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015075 *
15076 * @param depth the indentation level
15077 * @return a String containing (depth * 2 + 3) * 2 white spaces
15078 *
15079 * @hide
15080 */
15081 protected static String debugIndent(int depth) {
15082 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2);
15083 for (int i = 0; i < (depth * 2) + 3; i++) {
15084 spaces.append(' ').append(' ');
15085 }
15086 return spaces.toString();
15087 }
15088
15089 /**
15090 * <p>Return the offset of the widget's text baseline from the widget's top
15091 * boundary. If this widget does not support baseline alignment, this
15092 * method returns -1. </p>
15093 *
15094 * @return the offset of the baseline within the widget's bounds or -1
15095 * if baseline alignment is not supported
15096 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070015097 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015098 public int getBaseline() {
15099 return -1;
15100 }
15101
15102 /**
15103 * Call this when something has changed which has invalidated the
15104 * layout of this view. This will schedule a layout pass of the view
15105 * tree.
15106 */
15107 public void requestLayout() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070015108 mPrivateFlags |= PFLAG_FORCE_LAYOUT;
15109 mPrivateFlags |= PFLAG_INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015110
Fabrice Di Meglio4a5268852012-03-30 15:56:48 -070015111 if (mParent != null && !mParent.isLayoutRequested()) {
15112 mParent.requestLayout();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015113 }
15114 }
15115
15116 /**
15117 * Forces this view to be laid out during the next layout pass.
15118 * This method does not call requestLayout() or forceLayout()
15119 * on the parent.
15120 */
15121 public void forceLayout() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070015122 mPrivateFlags |= PFLAG_FORCE_LAYOUT;
15123 mPrivateFlags |= PFLAG_INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015124 }
15125
15126 /**
15127 * <p>
15128 * This is called to find out how big a view should be. The parent
15129 * supplies constraint information in the width and height parameters.
15130 * </p>
15131 *
15132 * <p>
Romain Guy967e2bf2012-02-07 17:04:34 -080015133 * The actual measurement work of a view is performed in
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015134 * {@link #onMeasure(int, int)}, called by this method. Therefore, only
Romain Guy967e2bf2012-02-07 17:04:34 -080015135 * {@link #onMeasure(int, int)} can and must be overridden by subclasses.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015136 * </p>
15137 *
15138 *
15139 * @param widthMeasureSpec Horizontal space requirements as imposed by the
15140 * parent
15141 * @param heightMeasureSpec Vertical space requirements as imposed by the
15142 * parent
15143 *
15144 * @see #onMeasure(int, int)
15145 */
15146 public final void measure(int widthMeasureSpec, int heightMeasureSpec) {
Dianne Hackborn4702a852012-08-17 15:18:29 -070015147 if ((mPrivateFlags & PFLAG_FORCE_LAYOUT) == PFLAG_FORCE_LAYOUT ||
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015148 widthMeasureSpec != mOldWidthMeasureSpec ||
15149 heightMeasureSpec != mOldHeightMeasureSpec) {
15150
15151 // first clears the measured dimension flag
Dianne Hackborn4702a852012-08-17 15:18:29 -070015152 mPrivateFlags &= ~PFLAG_MEASURED_DIMENSION_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015153
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -070015154 if (!isPaddingResolved()) {
Adam Powell0090f202012-08-07 17:15:30 -070015155 resolvePadding();
15156 }
15157
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015158 // measure ourselves, this should set the measured dimension flag back
15159 onMeasure(widthMeasureSpec, heightMeasureSpec);
15160
15161 // flag not set, setMeasuredDimension() was not invoked, we raise
15162 // an exception to warn the developer
Dianne Hackborn4702a852012-08-17 15:18:29 -070015163 if ((mPrivateFlags & PFLAG_MEASURED_DIMENSION_SET) != PFLAG_MEASURED_DIMENSION_SET) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015164 throw new IllegalStateException("onMeasure() did not set the"
15165 + " measured dimension by calling"
15166 + " setMeasuredDimension()");
15167 }
15168
Dianne Hackborn4702a852012-08-17 15:18:29 -070015169 mPrivateFlags |= PFLAG_LAYOUT_REQUIRED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015170 }
15171
15172 mOldWidthMeasureSpec = widthMeasureSpec;
15173 mOldHeightMeasureSpec = heightMeasureSpec;
15174 }
15175
15176 /**
15177 * <p>
15178 * Measure the view and its content to determine the measured width and the
15179 * measured height. This method is invoked by {@link #measure(int, int)} and
15180 * should be overriden by subclasses to provide accurate and efficient
15181 * measurement of their contents.
15182 * </p>
15183 *
15184 * <p>
15185 * <strong>CONTRACT:</strong> When overriding this method, you
15186 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the
15187 * measured width and height of this view. Failure to do so will trigger an
15188 * <code>IllegalStateException</code>, thrown by
15189 * {@link #measure(int, int)}. Calling the superclass'
15190 * {@link #onMeasure(int, int)} is a valid use.
15191 * </p>
15192 *
15193 * <p>
15194 * The base class implementation of measure defaults to the background size,
15195 * unless a larger size is allowed by the MeasureSpec. Subclasses should
15196 * override {@link #onMeasure(int, int)} to provide better measurements of
15197 * their content.
15198 * </p>
15199 *
15200 * <p>
15201 * If this method is overridden, it is the subclass's responsibility to make
15202 * sure the measured height and width are at least the view's minimum height
15203 * and width ({@link #getSuggestedMinimumHeight()} and
15204 * {@link #getSuggestedMinimumWidth()}).
15205 * </p>
15206 *
15207 * @param widthMeasureSpec horizontal space requirements as imposed by the parent.
15208 * The requirements are encoded with
15209 * {@link android.view.View.MeasureSpec}.
15210 * @param heightMeasureSpec vertical space requirements as imposed by the parent.
15211 * The requirements are encoded with
15212 * {@link android.view.View.MeasureSpec}.
15213 *
15214 * @see #getMeasuredWidth()
15215 * @see #getMeasuredHeight()
15216 * @see #setMeasuredDimension(int, int)
15217 * @see #getSuggestedMinimumHeight()
15218 * @see #getSuggestedMinimumWidth()
15219 * @see android.view.View.MeasureSpec#getMode(int)
15220 * @see android.view.View.MeasureSpec#getSize(int)
15221 */
15222 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
15223 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec),
15224 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec));
15225 }
15226
15227 /**
15228 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the
15229 * measured width and measured height. Failing to do so will trigger an
15230 * exception at measurement time.</p>
15231 *
Dianne Hackborn189ee182010-12-02 21:48:53 -080015232 * @param measuredWidth The measured width of this view. May be a complex
15233 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
15234 * {@link #MEASURED_STATE_TOO_SMALL}.
15235 * @param measuredHeight The measured height of this view. May be a complex
15236 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
15237 * {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015238 */
15239 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) {
15240 mMeasuredWidth = measuredWidth;
15241 mMeasuredHeight = measuredHeight;
15242
Dianne Hackborn4702a852012-08-17 15:18:29 -070015243 mPrivateFlags |= PFLAG_MEASURED_DIMENSION_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015244 }
15245
15246 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -080015247 * Merge two states as returned by {@link #getMeasuredState()}.
15248 * @param curState The current state as returned from a view or the result
15249 * of combining multiple views.
15250 * @param newState The new view state to combine.
15251 * @return Returns a new integer reflecting the combination of the two
15252 * states.
15253 */
15254 public static int combineMeasuredStates(int curState, int newState) {
15255 return curState | newState;
15256 }
15257
15258 /**
15259 * Version of {@link #resolveSizeAndState(int, int, int)}
15260 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result.
15261 */
15262 public static int resolveSize(int size, int measureSpec) {
15263 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK;
15264 }
15265
15266 /**
15267 * Utility to reconcile a desired size and state, with constraints imposed
15268 * by a MeasureSpec. Will take the desired size, unless a different size
15269 * is imposed by the constraints. The returned value is a compound integer,
15270 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and
15271 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting
15272 * size is smaller than the size the view wants to be.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015273 *
15274 * @param size How big the view wants to be
15275 * @param measureSpec Constraints imposed by the parent
Dianne Hackborn189ee182010-12-02 21:48:53 -080015276 * @return Size information bit mask as defined by
15277 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015278 */
Dianne Hackborn189ee182010-12-02 21:48:53 -080015279 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015280 int result = size;
15281 int specMode = MeasureSpec.getMode(measureSpec);
15282 int specSize = MeasureSpec.getSize(measureSpec);
15283 switch (specMode) {
15284 case MeasureSpec.UNSPECIFIED:
15285 result = size;
15286 break;
15287 case MeasureSpec.AT_MOST:
Dianne Hackborn189ee182010-12-02 21:48:53 -080015288 if (specSize < size) {
15289 result = specSize | MEASURED_STATE_TOO_SMALL;
15290 } else {
15291 result = size;
15292 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015293 break;
15294 case MeasureSpec.EXACTLY:
15295 result = specSize;
15296 break;
15297 }
Dianne Hackborn189ee182010-12-02 21:48:53 -080015298 return result | (childMeasuredState&MEASURED_STATE_MASK);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015299 }
15300
15301 /**
15302 * Utility to return a default size. Uses the supplied size if the
Romain Guy98029c82011-06-17 15:47:07 -070015303 * MeasureSpec imposed no constraints. Will get larger if allowed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015304 * by the MeasureSpec.
15305 *
15306 * @param size Default size for this view
15307 * @param measureSpec Constraints imposed by the parent
15308 * @return The size this view should be.
15309 */
15310 public static int getDefaultSize(int size, int measureSpec) {
15311 int result = size;
15312 int specMode = MeasureSpec.getMode(measureSpec);
Romain Guy98029c82011-06-17 15:47:07 -070015313 int specSize = MeasureSpec.getSize(measureSpec);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015314
15315 switch (specMode) {
15316 case MeasureSpec.UNSPECIFIED:
15317 result = size;
15318 break;
15319 case MeasureSpec.AT_MOST:
15320 case MeasureSpec.EXACTLY:
15321 result = specSize;
15322 break;
15323 }
15324 return result;
15325 }
15326
15327 /**
15328 * Returns the suggested minimum height that the view should use. This
15329 * returns the maximum of the view's minimum height
15330 * and the background's minimum height
15331 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}).
15332 * <p>
15333 * When being used in {@link #onMeasure(int, int)}, the caller should still
15334 * ensure the returned height is within the requirements of the parent.
15335 *
15336 * @return The suggested minimum height of the view.
15337 */
15338 protected int getSuggestedMinimumHeight() {
Philip Milne6c8ea062012-04-03 17:38:43 -070015339 return (mBackground == null) ? mMinHeight : max(mMinHeight, mBackground.getMinimumHeight());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015340
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015341 }
15342
15343 /**
15344 * Returns the suggested minimum width that the view should use. This
15345 * returns the maximum of the view's minimum width)
15346 * and the background's minimum width
15347 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}).
15348 * <p>
15349 * When being used in {@link #onMeasure(int, int)}, the caller should still
15350 * ensure the returned width is within the requirements of the parent.
15351 *
15352 * @return The suggested minimum width of the view.
15353 */
15354 protected int getSuggestedMinimumWidth() {
Philip Milne6c8ea062012-04-03 17:38:43 -070015355 return (mBackground == null) ? mMinWidth : max(mMinWidth, mBackground.getMinimumWidth());
15356 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015357
Philip Milne6c8ea062012-04-03 17:38:43 -070015358 /**
15359 * Returns the minimum height of the view.
15360 *
15361 * @return the minimum height the view will try to be.
15362 *
15363 * @see #setMinimumHeight(int)
15364 *
15365 * @attr ref android.R.styleable#View_minHeight
15366 */
15367 public int getMinimumHeight() {
15368 return mMinHeight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015369 }
15370
15371 /**
15372 * Sets the minimum height of the view. It is not guaranteed the view will
15373 * be able to achieve this minimum height (for example, if its parent layout
15374 * constrains it with less available height).
15375 *
15376 * @param minHeight The minimum height the view will try to be.
Philip Milne6c8ea062012-04-03 17:38:43 -070015377 *
15378 * @see #getMinimumHeight()
15379 *
15380 * @attr ref android.R.styleable#View_minHeight
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015381 */
15382 public void setMinimumHeight(int minHeight) {
15383 mMinHeight = minHeight;
Philip Milne6c8ea062012-04-03 17:38:43 -070015384 requestLayout();
15385 }
15386
15387 /**
15388 * Returns the minimum width of the view.
15389 *
15390 * @return the minimum width the view will try to be.
15391 *
15392 * @see #setMinimumWidth(int)
15393 *
15394 * @attr ref android.R.styleable#View_minWidth
15395 */
15396 public int getMinimumWidth() {
15397 return mMinWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015398 }
15399
15400 /**
15401 * Sets the minimum width of the view. It is not guaranteed the view will
15402 * be able to achieve this minimum width (for example, if its parent layout
15403 * constrains it with less available width).
15404 *
15405 * @param minWidth The minimum width the view will try to be.
Philip Milne6c8ea062012-04-03 17:38:43 -070015406 *
15407 * @see #getMinimumWidth()
15408 *
15409 * @attr ref android.R.styleable#View_minWidth
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015410 */
15411 public void setMinimumWidth(int minWidth) {
15412 mMinWidth = minWidth;
Philip Milne6c8ea062012-04-03 17:38:43 -070015413 requestLayout();
15414
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015415 }
15416
15417 /**
15418 * Get the animation currently associated with this view.
15419 *
15420 * @return The animation that is currently playing or
15421 * scheduled to play for this view.
15422 */
15423 public Animation getAnimation() {
15424 return mCurrentAnimation;
15425 }
15426
15427 /**
15428 * Start the specified animation now.
15429 *
15430 * @param animation the animation to start now
15431 */
15432 public void startAnimation(Animation animation) {
15433 animation.setStartTime(Animation.START_ON_FIRST_FRAME);
15434 setAnimation(animation);
Romain Guy0fd89bf2011-01-26 15:41:30 -080015435 invalidateParentCaches();
15436 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015437 }
15438
15439 /**
15440 * Cancels any animations for this view.
15441 */
15442 public void clearAnimation() {
Romain Guy305a2eb2010-02-09 11:30:44 -080015443 if (mCurrentAnimation != null) {
Romain Guyb4a107d2010-02-09 18:50:08 -080015444 mCurrentAnimation.detach();
Romain Guy305a2eb2010-02-09 11:30:44 -080015445 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015446 mCurrentAnimation = null;
Romain Guy0fd89bf2011-01-26 15:41:30 -080015447 invalidateParentIfNeeded();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015448 }
15449
15450 /**
15451 * Sets the next animation to play for this view.
15452 * If you want the animation to play immediately, use
Chet Haase42428932012-05-11 15:39:07 -070015453 * {@link #startAnimation(android.view.animation.Animation)} instead.
15454 * This method provides allows fine-grained
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015455 * control over the start time and invalidation, but you
15456 * must make sure that 1) the animation has a start time set, and
Chet Haase42428932012-05-11 15:39:07 -070015457 * 2) the view's parent (which controls animations on its children)
15458 * will be invalidated when the animation is supposed to
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015459 * start.
15460 *
15461 * @param animation The next animation, or null.
15462 */
15463 public void setAnimation(Animation animation) {
15464 mCurrentAnimation = animation;
Romain Guyeb378892012-04-12 11:33:14 -070015465
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015466 if (animation != null) {
Romain Guyeb378892012-04-12 11:33:14 -070015467 // If the screen is off assume the animation start time is now instead of
15468 // the next frame we draw. Keeping the START_ON_FIRST_FRAME start time
15469 // would cause the animation to start when the screen turns back on
15470 if (mAttachInfo != null && !mAttachInfo.mScreenOn &&
15471 animation.getStartTime() == Animation.START_ON_FIRST_FRAME) {
15472 animation.setStartTime(AnimationUtils.currentAnimationTimeMillis());
15473 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015474 animation.reset();
15475 }
15476 }
15477
15478 /**
15479 * Invoked by a parent ViewGroup to notify the start of the animation
15480 * currently associated with this view. If you override this method,
15481 * always call super.onAnimationStart();
15482 *
15483 * @see #setAnimation(android.view.animation.Animation)
15484 * @see #getAnimation()
15485 */
15486 protected void onAnimationStart() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070015487 mPrivateFlags |= PFLAG_ANIMATION_STARTED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015488 }
15489
15490 /**
15491 * Invoked by a parent ViewGroup to notify the end of the animation
15492 * currently associated with this view. If you override this method,
15493 * always call super.onAnimationEnd();
15494 *
15495 * @see #setAnimation(android.view.animation.Animation)
15496 * @see #getAnimation()
15497 */
15498 protected void onAnimationEnd() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070015499 mPrivateFlags &= ~PFLAG_ANIMATION_STARTED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015500 }
15501
15502 /**
15503 * Invoked if there is a Transform that involves alpha. Subclass that can
15504 * draw themselves with the specified alpha should return true, and then
15505 * respect that alpha when their onDraw() is called. If this returns false
15506 * then the view may be redirected to draw into an offscreen buffer to
15507 * fulfill the request, which will look fine, but may be slower than if the
15508 * subclass handles it internally. The default implementation returns false.
15509 *
15510 * @param alpha The alpha (0..255) to apply to the view's drawing
15511 * @return true if the view can draw with the specified alpha.
15512 */
15513 protected boolean onSetAlpha(int alpha) {
15514 return false;
15515 }
15516
15517 /**
15518 * This is used by the RootView to perform an optimization when
15519 * the view hierarchy contains one or several SurfaceView.
15520 * SurfaceView is always considered transparent, but its children are not,
15521 * therefore all View objects remove themselves from the global transparent
15522 * region (passed as a parameter to this function).
15523 *
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070015524 * @param region The transparent region for this ViewAncestor (window).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015525 *
15526 * @return Returns true if the effective visibility of the view at this
15527 * point is opaque, regardless of the transparent region; returns false
15528 * if it is possible for underlying windows to be seen behind the view.
15529 *
15530 * {@hide}
15531 */
15532 public boolean gatherTransparentRegion(Region region) {
15533 final AttachInfo attachInfo = mAttachInfo;
15534 if (region != null && attachInfo != null) {
15535 final int pflags = mPrivateFlags;
Dianne Hackborn4702a852012-08-17 15:18:29 -070015536 if ((pflags & PFLAG_SKIP_DRAW) == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015537 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to
15538 // remove it from the transparent region.
15539 final int[] location = attachInfo.mTransparentLocation;
15540 getLocationInWindow(location);
15541 region.op(location[0], location[1], location[0] + mRight - mLeft,
15542 location[1] + mBottom - mTop, Region.Op.DIFFERENCE);
Dianne Hackborn4702a852012-08-17 15:18:29 -070015543 } else if ((pflags & PFLAG_ONLY_DRAWS_BACKGROUND) != 0 && mBackground != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015544 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable
15545 // exists, so we remove the background drawable's non-transparent
15546 // parts from this transparent region.
Philip Milne6c8ea062012-04-03 17:38:43 -070015547 applyDrawableToTransparentRegion(mBackground, region);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015548 }
15549 }
15550 return true;
15551 }
15552
15553 /**
15554 * Play a sound effect for this view.
15555 *
15556 * <p>The framework will play sound effects for some built in actions, such as
15557 * clicking, but you may wish to play these effects in your widget,
15558 * for instance, for internal navigation.
15559 *
15560 * <p>The sound effect will only be played if sound effects are enabled by the user, and
15561 * {@link #isSoundEffectsEnabled()} is true.
15562 *
15563 * @param soundConstant One of the constants defined in {@link SoundEffectConstants}
15564 */
15565 public void playSoundEffect(int soundConstant) {
15566 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) {
15567 return;
15568 }
15569 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant);
15570 }
15571
15572 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015573 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070015574 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015575 * <p>Provide haptic feedback to the user for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015576 *
15577 * <p>The framework will provide haptic feedback for some built in actions,
15578 * such as long presses, but you may wish to provide feedback for your
15579 * own widget.
15580 *
15581 * <p>The feedback will only be performed if
15582 * {@link #isHapticFeedbackEnabled()} is true.
15583 *
15584 * @param feedbackConstant One of the constants defined in
15585 * {@link HapticFeedbackConstants}
15586 */
15587 public boolean performHapticFeedback(int feedbackConstant) {
15588 return performHapticFeedback(feedbackConstant, 0);
15589 }
15590
15591 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015592 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070015593 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015594 * <p>Like {@link #performHapticFeedback(int)}, with additional options.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015595 *
15596 * @param feedbackConstant One of the constants defined in
15597 * {@link HapticFeedbackConstants}
15598 * @param flags Additional flags as per {@link HapticFeedbackConstants}.
15599 */
15600 public boolean performHapticFeedback(int feedbackConstant, int flags) {
15601 if (mAttachInfo == null) {
15602 return false;
15603 }
Romain Guyf607bdc2010-09-10 19:20:06 -070015604 //noinspection SimplifiableIfStatement
Romain Guy812ccbe2010-06-01 14:07:24 -070015605 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015606 && !isHapticFeedbackEnabled()) {
15607 return false;
15608 }
Romain Guy812ccbe2010-06-01 14:07:24 -070015609 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant,
15610 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015611 }
15612
15613 /**
Dianne Hackborn98014352012-04-05 18:31:41 -070015614 * Request that the visibility of the status bar or other screen/window
15615 * decorations be changed.
15616 *
15617 * <p>This method is used to put the over device UI into temporary modes
15618 * where the user's attention is focused more on the application content,
15619 * by dimming or hiding surrounding system affordances. This is typically
15620 * used in conjunction with {@link Window#FEATURE_ACTION_BAR_OVERLAY
15621 * Window.FEATURE_ACTION_BAR_OVERLAY}, allowing the applications content
15622 * to be placed behind the action bar (and with these flags other system
15623 * affordances) so that smooth transitions between hiding and showing them
15624 * can be done.
15625 *
15626 * <p>Two representative examples of the use of system UI visibility is
15627 * implementing a content browsing application (like a magazine reader)
15628 * and a video playing application.
15629 *
15630 * <p>The first code shows a typical implementation of a View in a content
15631 * browsing application. In this implementation, the application goes
15632 * into a content-oriented mode by hiding the status bar and action bar,
15633 * and putting the navigation elements into lights out mode. The user can
15634 * then interact with content while in this mode. Such an application should
15635 * provide an easy way for the user to toggle out of the mode (such as to
15636 * check information in the status bar or access notifications). In the
15637 * implementation here, this is done simply by tapping on the content.
15638 *
15639 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/ContentBrowserActivity.java
15640 * content}
15641 *
15642 * <p>This second code sample shows a typical implementation of a View
15643 * in a video playing application. In this situation, while the video is
15644 * playing the application would like to go into a complete full-screen mode,
15645 * to use as much of the display as possible for the video. When in this state
15646 * the user can not interact with the application; the system intercepts
Dianne Hackborncf675782012-05-10 15:07:24 -070015647 * touching on the screen to pop the UI out of full screen mode. See
15648 * {@link #fitSystemWindows(Rect)} for a sample layout that goes with this code.
Dianne Hackborn98014352012-04-05 18:31:41 -070015649 *
15650 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/VideoPlayerActivity.java
15651 * content}
15652 *
15653 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE},
15654 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN},
15655 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION},
15656 * and {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}.
Joe Onorato664644d2011-01-23 17:53:23 -080015657 */
15658 public void setSystemUiVisibility(int visibility) {
Daniel Sandler70524062011-09-21 00:30:47 -040015659 if (visibility != mSystemUiVisibility) {
15660 mSystemUiVisibility = visibility;
15661 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
15662 mParent.recomputeViewAttributes(this);
15663 }
Joe Onorato664644d2011-01-23 17:53:23 -080015664 }
15665 }
15666
15667 /**
Dianne Hackborn98014352012-04-05 18:31:41 -070015668 * Returns the last {@link #setSystemUiVisibility(int) that this view has requested.
15669 * @return Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE},
15670 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN},
15671 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION},
15672 * and {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}.
Joe Onorato664644d2011-01-23 17:53:23 -080015673 */
Joe Onoratoe595cad2011-01-24 09:22:12 -080015674 public int getSystemUiVisibility() {
Joe Onorato664644d2011-01-23 17:53:23 -080015675 return mSystemUiVisibility;
15676 }
15677
Scott Mainec6331b2011-05-24 16:55:56 -070015678 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -070015679 * Returns the current system UI visibility that is currently set for
15680 * the entire window. This is the combination of the
15681 * {@link #setSystemUiVisibility(int)} values supplied by all of the
15682 * views in the window.
15683 */
15684 public int getWindowSystemUiVisibility() {
15685 return mAttachInfo != null ? mAttachInfo.mSystemUiVisibility : 0;
15686 }
15687
15688 /**
15689 * Override to find out when the window's requested system UI visibility
15690 * has changed, that is the value returned by {@link #getWindowSystemUiVisibility()}.
15691 * This is different from the callbacks recieved through
15692 * {@link #setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener)}
15693 * in that this is only telling you about the local request of the window,
15694 * not the actual values applied by the system.
15695 */
15696 public void onWindowSystemUiVisibilityChanged(int visible) {
15697 }
15698
15699 /**
15700 * Dispatch callbacks to {@link #onWindowSystemUiVisibilityChanged(int)} down
15701 * the view hierarchy.
15702 */
15703 public void dispatchWindowSystemUiVisiblityChanged(int visible) {
15704 onWindowSystemUiVisibilityChanged(visible);
15705 }
15706
15707 /**
Scott Mainec6331b2011-05-24 16:55:56 -070015708 * Set a listener to receive callbacks when the visibility of the system bar changes.
15709 * @param l The {@link OnSystemUiVisibilityChangeListener} to receive callbacks.
15710 */
Joe Onorato664644d2011-01-23 17:53:23 -080015711 public void setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070015712 getListenerInfo().mOnSystemUiVisibilityChangeListener = l;
Joe Onorato664644d2011-01-23 17:53:23 -080015713 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
15714 mParent.recomputeViewAttributes(this);
15715 }
15716 }
15717
15718 /**
Dianne Hackborn9a230e02011-10-06 11:51:27 -070015719 * Dispatch callbacks to {@link #setOnSystemUiVisibilityChangeListener} down
15720 * the view hierarchy.
Joe Onorato664644d2011-01-23 17:53:23 -080015721 */
15722 public void dispatchSystemUiVisibilityChanged(int visibility) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070015723 ListenerInfo li = mListenerInfo;
15724 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) {
15725 li.mOnSystemUiVisibilityChangeListener.onSystemUiVisibilityChange(
Joe Onorato6ab77bd2011-01-31 11:21:10 -080015726 visibility & PUBLIC_STATUS_BAR_VISIBILITY_MASK);
Joe Onorato664644d2011-01-23 17:53:23 -080015727 }
15728 }
15729
Dianne Hackborncf675782012-05-10 15:07:24 -070015730 boolean updateLocalSystemUiVisibility(int localValue, int localChanges) {
Dianne Hackborn9a230e02011-10-06 11:51:27 -070015731 int val = (mSystemUiVisibility&~localChanges) | (localValue&localChanges);
15732 if (val != mSystemUiVisibility) {
15733 setSystemUiVisibility(val);
Dianne Hackborncf675782012-05-10 15:07:24 -070015734 return true;
Dianne Hackborn9a230e02011-10-06 11:51:27 -070015735 }
Dianne Hackborncf675782012-05-10 15:07:24 -070015736 return false;
Dianne Hackborn9a230e02011-10-06 11:51:27 -070015737 }
15738
Dianne Hackborn139e5aa2012-05-05 20:36:38 -070015739 /** @hide */
15740 public void setDisabledSystemUiVisibility(int flags) {
15741 if (mAttachInfo != null) {
15742 if (mAttachInfo.mDisabledSystemUiVisibility != flags) {
15743 mAttachInfo.mDisabledSystemUiVisibility = flags;
15744 if (mParent != null) {
15745 mParent.recomputeViewAttributes(this);
15746 }
15747 }
15748 }
15749 }
15750
Joe Onorato664644d2011-01-23 17:53:23 -080015751 /**
Joe Malin32736f02011-01-19 16:14:20 -080015752 * Creates an image that the system displays during the drag and drop
15753 * operation. This is called a &quot;drag shadow&quot;. The default implementation
15754 * for a DragShadowBuilder based on a View returns an image that has exactly the same
15755 * appearance as the given View. The default also positions the center of the drag shadow
15756 * directly under the touch point. If no View is provided (the constructor with no parameters
15757 * is used), and {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} and
15758 * {@link #onDrawShadow(Canvas) onDrawShadow()} are not overriden, then the
15759 * default is an invisible drag shadow.
15760 * <p>
15761 * You are not required to use the View you provide to the constructor as the basis of the
15762 * drag shadow. The {@link #onDrawShadow(Canvas) onDrawShadow()} method allows you to draw
15763 * anything you want as the drag shadow.
15764 * </p>
15765 * <p>
15766 * You pass a DragShadowBuilder object to the system when you start the drag. The system
15767 * calls {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} to get the
15768 * size and position of the drag shadow. It uses this data to construct a
15769 * {@link android.graphics.Canvas} object, then it calls {@link #onDrawShadow(Canvas) onDrawShadow()}
15770 * so that your application can draw the shadow image in the Canvas.
15771 * </p>
Joe Fernandez558459f2011-10-13 16:47:36 -070015772 *
15773 * <div class="special reference">
15774 * <h3>Developer Guides</h3>
15775 * <p>For a guide to implementing drag and drop features, read the
15776 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p>
15777 * </div>
Christopher Tate2c095f32010-10-04 14:13:40 -070015778 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015779 public static class DragShadowBuilder {
Christopher Tatea0374192010-10-05 13:06:41 -070015780 private final WeakReference<View> mView;
Christopher Tate2c095f32010-10-04 14:13:40 -070015781
15782 /**
Joe Malin32736f02011-01-19 16:14:20 -080015783 * Constructs a shadow image builder based on a View. By default, the resulting drag
15784 * shadow will have the same appearance and dimensions as the View, with the touch point
15785 * over the center of the View.
15786 * @param view A View. Any View in scope can be used.
Christopher Tate2c095f32010-10-04 14:13:40 -070015787 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015788 public DragShadowBuilder(View view) {
Christopher Tatea0374192010-10-05 13:06:41 -070015789 mView = new WeakReference<View>(view);
Christopher Tate2c095f32010-10-04 14:13:40 -070015790 }
15791
Christopher Tate17ed60c2011-01-18 12:50:26 -080015792 /**
15793 * Construct a shadow builder object with no associated View. This
15794 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)}
15795 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order
15796 * to supply the drag shadow's dimensions and appearance without
Joe Malin32736f02011-01-19 16:14:20 -080015797 * reference to any View object. If they are not overridden, then the result is an
15798 * invisible drag shadow.
Christopher Tate17ed60c2011-01-18 12:50:26 -080015799 */
15800 public DragShadowBuilder() {
15801 mView = new WeakReference<View>(null);
15802 }
15803
15804 /**
15805 * Returns the View object that had been passed to the
15806 * {@link #View.DragShadowBuilder(View)}
15807 * constructor. If that View parameter was {@code null} or if the
15808 * {@link #View.DragShadowBuilder()}
15809 * constructor was used to instantiate the builder object, this method will return
15810 * null.
15811 *
15812 * @return The View object associate with this builder object.
15813 */
Romain Guy5c22a8c2011-05-13 11:48:45 -070015814 @SuppressWarnings({"JavadocReference"})
Chris Tate6b391282010-10-14 15:48:59 -070015815 final public View getView() {
15816 return mView.get();
15817 }
15818
Christopher Tate2c095f32010-10-04 14:13:40 -070015819 /**
Joe Malin32736f02011-01-19 16:14:20 -080015820 * Provides the metrics for the shadow image. These include the dimensions of
15821 * the shadow image, and the point within that shadow that should
Christopher Tate2c095f32010-10-04 14:13:40 -070015822 * be centered under the touch location while dragging.
15823 * <p>
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015824 * The default implementation sets the dimensions of the shadow to be the
Joe Malin32736f02011-01-19 16:14:20 -080015825 * same as the dimensions of the View itself and centers the shadow under
15826 * the touch point.
15827 * </p>
Christopher Tate2c095f32010-10-04 14:13:40 -070015828 *
Joe Malin32736f02011-01-19 16:14:20 -080015829 * @param shadowSize A {@link android.graphics.Point} containing the width and height
15830 * of the shadow image. Your application must set {@link android.graphics.Point#x} to the
15831 * desired width and must set {@link android.graphics.Point#y} to the desired height of the
15832 * image.
15833 *
15834 * @param shadowTouchPoint A {@link android.graphics.Point} for the position within the
15835 * shadow image that should be underneath the touch point during the drag and drop
15836 * operation. Your application must set {@link android.graphics.Point#x} to the
15837 * X coordinate and {@link android.graphics.Point#y} to the Y coordinate of this position.
Christopher Tate2c095f32010-10-04 14:13:40 -070015838 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015839 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) {
Christopher Tatea0374192010-10-05 13:06:41 -070015840 final View view = mView.get();
15841 if (view != null) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015842 shadowSize.set(view.getWidth(), view.getHeight());
15843 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2);
Christopher Tatea0374192010-10-05 13:06:41 -070015844 } else {
15845 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view");
15846 }
Christopher Tate2c095f32010-10-04 14:13:40 -070015847 }
15848
15849 /**
Joe Malin32736f02011-01-19 16:14:20 -080015850 * Draws the shadow image. The system creates the {@link android.graphics.Canvas} object
15851 * based on the dimensions it received from the
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015852 * {@link #onProvideShadowMetrics(Point, Point)} callback.
Christopher Tate2c095f32010-10-04 14:13:40 -070015853 *
Joe Malin32736f02011-01-19 16:14:20 -080015854 * @param canvas A {@link android.graphics.Canvas} object in which to draw the shadow image.
Christopher Tate2c095f32010-10-04 14:13:40 -070015855 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015856 public void onDrawShadow(Canvas canvas) {
Christopher Tatea0374192010-10-05 13:06:41 -070015857 final View view = mView.get();
15858 if (view != null) {
15859 view.draw(canvas);
15860 } else {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015861 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view");
Christopher Tatea0374192010-10-05 13:06:41 -070015862 }
Christopher Tate2c095f32010-10-04 14:13:40 -070015863 }
15864 }
15865
15866 /**
Joe Malin32736f02011-01-19 16:14:20 -080015867 * Starts a drag and drop operation. When your application calls this method, it passes a
15868 * {@link android.view.View.DragShadowBuilder} object to the system. The
15869 * system calls this object's {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)}
15870 * to get metrics for the drag shadow, and then calls the object's
15871 * {@link DragShadowBuilder#onDrawShadow(Canvas)} to draw the drag shadow itself.
15872 * <p>
15873 * Once the system has the drag shadow, it begins the drag and drop operation by sending
15874 * drag events to all the View objects in your application that are currently visible. It does
15875 * this either by calling the View object's drag listener (an implementation of
15876 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent) onDrag()} or by calling the
15877 * View object's {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} method.
15878 * Both are passed a {@link android.view.DragEvent} object that has a
15879 * {@link android.view.DragEvent#getAction()} value of
15880 * {@link android.view.DragEvent#ACTION_DRAG_STARTED}.
15881 * </p>
15882 * <p>
15883 * Your application can invoke startDrag() on any attached View object. The View object does not
15884 * need to be the one used in {@link android.view.View.DragShadowBuilder}, nor does it need to
15885 * be related to the View the user selected for dragging.
15886 * </p>
15887 * @param data A {@link android.content.ClipData} object pointing to the data to be
15888 * transferred by the drag and drop operation.
15889 * @param shadowBuilder A {@link android.view.View.DragShadowBuilder} object for building the
15890 * drag shadow.
15891 * @param myLocalState An {@link java.lang.Object} containing local data about the drag and
15892 * drop operation. This Object is put into every DragEvent object sent by the system during the
15893 * current drag.
15894 * <p>
15895 * myLocalState is a lightweight mechanism for the sending information from the dragged View
15896 * to the target Views. For example, it can contain flags that differentiate between a
15897 * a copy operation and a move operation.
15898 * </p>
15899 * @param flags Flags that control the drag and drop operation. No flags are currently defined,
15900 * so the parameter should be set to 0.
15901 * @return {@code true} if the method completes successfully, or
15902 * {@code false} if it fails anywhere. Returning {@code false} means the system was unable to
15903 * do a drag, and so no drag operation is in progress.
Christopher Tatea53146c2010-09-07 11:57:52 -070015904 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015905 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080015906 Object myLocalState, int flags) {
Christopher Tate2c095f32010-10-04 14:13:40 -070015907 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate02d2b3b2011-01-10 20:43:53 -080015908 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags);
Christopher Tatea53146c2010-09-07 11:57:52 -070015909 }
15910 boolean okay = false;
15911
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015912 Point shadowSize = new Point();
15913 Point shadowTouchPoint = new Point();
15914 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint);
Christopher Tate2c095f32010-10-04 14:13:40 -070015915
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015916 if ((shadowSize.x < 0) || (shadowSize.y < 0) ||
15917 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) {
15918 throw new IllegalStateException("Drag shadow dimensions must not be negative");
Christopher Tate2c095f32010-10-04 14:13:40 -070015919 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015920
Chris Tatea32dcf72010-10-14 12:13:50 -070015921 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015922 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y
15923 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y);
Chris Tatea32dcf72010-10-14 12:13:50 -070015924 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015925 Surface surface = new Surface();
15926 try {
15927 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080015928 flags, shadowSize.x, shadowSize.y, surface);
Christopher Tate2c095f32010-10-04 14:13:40 -070015929 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token
Christopher Tatea53146c2010-09-07 11:57:52 -070015930 + " surface=" + surface);
15931 if (token != null) {
15932 Canvas canvas = surface.lockCanvas(null);
Romain Guy0bb56672010-10-01 00:25:02 -070015933 try {
Chris Tate6b391282010-10-14 15:48:59 -070015934 canvas.drawColor(0, PorterDuff.Mode.CLEAR);
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015935 shadowBuilder.onDrawShadow(canvas);
Romain Guy0bb56672010-10-01 00:25:02 -070015936 } finally {
15937 surface.unlockCanvasAndPost(canvas);
15938 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015939
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070015940 final ViewRootImpl root = getViewRootImpl();
Christopher Tate407b4e92010-11-30 17:14:08 -080015941
15942 // Cache the local state object for delivery with DragEvents
15943 root.setLocalDragState(myLocalState);
15944
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015945 // repurpose 'shadowSize' for the last touch point
15946 root.getLastTouchPoint(shadowSize);
Christopher Tate2c095f32010-10-04 14:13:40 -070015947
Christopher Tatea53146c2010-09-07 11:57:52 -070015948 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token,
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015949 shadowSize.x, shadowSize.y,
15950 shadowTouchPoint.x, shadowTouchPoint.y, data);
Christopher Tate2c095f32010-10-04 14:13:40 -070015951 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay);
Christopher Tate8f73b5d2011-09-12 15:22:12 -070015952
15953 // Off and running! Release our local surface instance; the drag
15954 // shadow surface is now managed by the system process.
15955 surface.release();
Christopher Tatea53146c2010-09-07 11:57:52 -070015956 }
15957 } catch (Exception e) {
15958 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e);
15959 surface.destroy();
15960 }
15961
15962 return okay;
15963 }
15964
Christopher Tatea53146c2010-09-07 11:57:52 -070015965 /**
Joe Malin32736f02011-01-19 16:14:20 -080015966 * Handles drag events sent by the system following a call to
15967 * {@link android.view.View#startDrag(ClipData,DragShadowBuilder,Object,int) startDrag()}.
15968 *<p>
15969 * When the system calls this method, it passes a
15970 * {@link android.view.DragEvent} object. A call to
15971 * {@link android.view.DragEvent#getAction()} returns one of the action type constants defined
15972 * in DragEvent. The method uses these to determine what is happening in the drag and drop
15973 * operation.
15974 * @param event The {@link android.view.DragEvent} sent by the system.
15975 * The {@link android.view.DragEvent#getAction()} method returns an action type constant defined
15976 * in DragEvent, indicating the type of drag event represented by this object.
15977 * @return {@code true} if the method was successful, otherwise {@code false}.
15978 * <p>
15979 * The method should return {@code true} in response to an action type of
15980 * {@link android.view.DragEvent#ACTION_DRAG_STARTED} to receive drag events for the current
15981 * operation.
15982 * </p>
15983 * <p>
15984 * The method should also return {@code true} in response to an action type of
15985 * {@link android.view.DragEvent#ACTION_DROP} if it consumed the drop, or
15986 * {@code false} if it didn't.
15987 * </p>
Christopher Tatea53146c2010-09-07 11:57:52 -070015988 */
Christopher Tate5ada6cb2010-10-05 14:15:29 -070015989 public boolean onDragEvent(DragEvent event) {
Christopher Tatea53146c2010-09-07 11:57:52 -070015990 return false;
15991 }
15992
15993 /**
Joe Malin32736f02011-01-19 16:14:20 -080015994 * Detects if this View is enabled and has a drag event listener.
15995 * If both are true, then it calls the drag event listener with the
15996 * {@link android.view.DragEvent} it received. If the drag event listener returns
15997 * {@code true}, then dispatchDragEvent() returns {@code true}.
15998 * <p>
15999 * For all other cases, the method calls the
16000 * {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} drag event handler
16001 * method and returns its result.
16002 * </p>
16003 * <p>
16004 * This ensures that a drag event is always consumed, even if the View does not have a drag
16005 * event listener. However, if the View has a listener and the listener returns true, then
16006 * onDragEvent() is not called.
16007 * </p>
Christopher Tatea53146c2010-09-07 11:57:52 -070016008 */
16009 public boolean dispatchDragEvent(DragEvent event) {
Romain Guy676b1732011-02-14 14:45:33 -080016010 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070016011 ListenerInfo li = mListenerInfo;
16012 if (li != null && li.mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
16013 && li.mOnDragListener.onDrag(this, event)) {
Chris Tate32affef2010-10-18 15:29:21 -070016014 return true;
16015 }
Christopher Tatea53146c2010-09-07 11:57:52 -070016016 return onDragEvent(event);
16017 }
16018
Christopher Tate3d4bf172011-03-28 16:16:46 -070016019 boolean canAcceptDrag() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070016020 return (mPrivateFlags2 & PFLAG2_DRAG_CAN_ACCEPT) != 0;
Christopher Tate3d4bf172011-03-28 16:16:46 -070016021 }
16022
Christopher Tatea53146c2010-09-07 11:57:52 -070016023 /**
Dianne Hackbornffa42482009-09-23 22:20:11 -070016024 * This needs to be a better API (NOT ON VIEW) before it is exposed. If
16025 * it is ever exposed at all.
Dianne Hackborn29e4a3c2009-09-30 22:35:40 -070016026 * @hide
Dianne Hackbornffa42482009-09-23 22:20:11 -070016027 */
16028 public void onCloseSystemDialogs(String reason) {
16029 }
Joe Malin32736f02011-01-19 16:14:20 -080016030
Dianne Hackbornffa42482009-09-23 22:20:11 -070016031 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016032 * Given a Drawable whose bounds have been set to draw into this view,
Romain Guy5c22a8c2011-05-13 11:48:45 -070016033 * update a Region being computed for
16034 * {@link #gatherTransparentRegion(android.graphics.Region)} so
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016035 * that any non-transparent parts of the Drawable are removed from the
16036 * given transparent region.
16037 *
16038 * @param dr The Drawable whose transparency is to be applied to the region.
16039 * @param region A Region holding the current transparency information,
16040 * where any parts of the region that are set are considered to be
16041 * transparent. On return, this region will be modified to have the
16042 * transparency information reduced by the corresponding parts of the
16043 * Drawable that are not transparent.
16044 * {@hide}
16045 */
16046 public void applyDrawableToTransparentRegion(Drawable dr, Region region) {
16047 if (DBG) {
16048 Log.i("View", "Getting transparent region for: " + this);
16049 }
16050 final Region r = dr.getTransparentRegion();
16051 final Rect db = dr.getBounds();
16052 final AttachInfo attachInfo = mAttachInfo;
16053 if (r != null && attachInfo != null) {
16054 final int w = getRight()-getLeft();
16055 final int h = getBottom()-getTop();
16056 if (db.left > 0) {
16057 //Log.i("VIEW", "Drawable left " + db.left + " > view 0");
16058 r.op(0, 0, db.left, h, Region.Op.UNION);
16059 }
16060 if (db.right < w) {
16061 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w);
16062 r.op(db.right, 0, w, h, Region.Op.UNION);
16063 }
16064 if (db.top > 0) {
16065 //Log.i("VIEW", "Drawable top " + db.top + " > view 0");
16066 r.op(0, 0, w, db.top, Region.Op.UNION);
16067 }
16068 if (db.bottom < h) {
16069 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h);
16070 r.op(0, db.bottom, w, h, Region.Op.UNION);
16071 }
16072 final int[] location = attachInfo.mTransparentLocation;
16073 getLocationInWindow(location);
16074 r.translate(location[0], location[1]);
16075 region.op(r, Region.Op.INTERSECT);
16076 } else {
16077 region.op(db, Region.Op.DIFFERENCE);
16078 }
16079 }
16080
Patrick Dubroye0a799a2011-05-04 16:19:22 -070016081 private void checkForLongClick(int delayOffset) {
16082 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
16083 mHasPerformedLongPress = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016084
Patrick Dubroye0a799a2011-05-04 16:19:22 -070016085 if (mPendingCheckForLongPress == null) {
16086 mPendingCheckForLongPress = new CheckForLongPress();
16087 }
16088 mPendingCheckForLongPress.rememberWindowAttachCount();
16089 postDelayed(mPendingCheckForLongPress,
16090 ViewConfiguration.getLongPressTimeout() - delayOffset);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016091 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016092 }
16093
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016094 /**
16095 * Inflate a view from an XML resource. This convenience method wraps the {@link
16096 * LayoutInflater} class, which provides a full range of options for view inflation.
16097 *
16098 * @param context The Context object for your activity or application.
16099 * @param resource The resource ID to inflate
16100 * @param root A view group that will be the parent. Used to properly inflate the
16101 * layout_* parameters.
16102 * @see LayoutInflater
16103 */
16104 public static View inflate(Context context, int resource, ViewGroup root) {
16105 LayoutInflater factory = LayoutInflater.from(context);
16106 return factory.inflate(resource, root);
16107 }
Romain Guy33e72ae2010-07-17 12:40:29 -070016108
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016109 /**
Adam Powell637d3372010-08-25 14:37:03 -070016110 * Scroll the view with standard behavior for scrolling beyond the normal
16111 * content boundaries. Views that call this method should override
16112 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the
16113 * results of an over-scroll operation.
16114 *
16115 * Views can use this method to handle any touch or fling-based scrolling.
16116 *
16117 * @param deltaX Change in X in pixels
16118 * @param deltaY Change in Y in pixels
16119 * @param scrollX Current X scroll value in pixels before applying deltaX
16120 * @param scrollY Current Y scroll value in pixels before applying deltaY
16121 * @param scrollRangeX Maximum content scroll range along the X axis
16122 * @param scrollRangeY Maximum content scroll range along the Y axis
16123 * @param maxOverScrollX Number of pixels to overscroll by in either direction
16124 * along the X axis.
16125 * @param maxOverScrollY Number of pixels to overscroll by in either direction
16126 * along the Y axis.
16127 * @param isTouchEvent true if this scroll operation is the result of a touch event.
16128 * @return true if scrolling was clamped to an over-scroll boundary along either
16129 * axis, false otherwise.
16130 */
Romain Guy7b5b6ab2011-03-14 18:05:08 -070016131 @SuppressWarnings({"UnusedParameters"})
Adam Powell637d3372010-08-25 14:37:03 -070016132 protected boolean overScrollBy(int deltaX, int deltaY,
16133 int scrollX, int scrollY,
16134 int scrollRangeX, int scrollRangeY,
16135 int maxOverScrollX, int maxOverScrollY,
16136 boolean isTouchEvent) {
16137 final int overScrollMode = mOverScrollMode;
16138 final boolean canScrollHorizontal =
16139 computeHorizontalScrollRange() > computeHorizontalScrollExtent();
16140 final boolean canScrollVertical =
16141 computeVerticalScrollRange() > computeVerticalScrollExtent();
16142 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS ||
16143 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal);
16144 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS ||
16145 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical);
16146
16147 int newScrollX = scrollX + deltaX;
16148 if (!overScrollHorizontal) {
16149 maxOverScrollX = 0;
16150 }
16151
16152 int newScrollY = scrollY + deltaY;
16153 if (!overScrollVertical) {
16154 maxOverScrollY = 0;
16155 }
16156
16157 // Clamp values if at the limits and record
16158 final int left = -maxOverScrollX;
16159 final int right = maxOverScrollX + scrollRangeX;
16160 final int top = -maxOverScrollY;
16161 final int bottom = maxOverScrollY + scrollRangeY;
16162
16163 boolean clampedX = false;
16164 if (newScrollX > right) {
16165 newScrollX = right;
16166 clampedX = true;
16167 } else if (newScrollX < left) {
16168 newScrollX = left;
16169 clampedX = true;
16170 }
16171
16172 boolean clampedY = false;
16173 if (newScrollY > bottom) {
16174 newScrollY = bottom;
16175 clampedY = true;
16176 } else if (newScrollY < top) {
16177 newScrollY = top;
16178 clampedY = true;
16179 }
16180
16181 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY);
16182
16183 return clampedX || clampedY;
16184 }
16185
16186 /**
16187 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to
16188 * respond to the results of an over-scroll operation.
16189 *
16190 * @param scrollX New X scroll value in pixels
16191 * @param scrollY New Y scroll value in pixels
16192 * @param clampedX True if scrollX was clamped to an over-scroll boundary
16193 * @param clampedY True if scrollY was clamped to an over-scroll boundary
16194 */
16195 protected void onOverScrolled(int scrollX, int scrollY,
16196 boolean clampedX, boolean clampedY) {
16197 // Intentionally empty.
16198 }
16199
16200 /**
16201 * Returns the over-scroll mode for this view. The result will be
16202 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
16203 * (allow over-scrolling only if the view content is larger than the container),
16204 * or {@link #OVER_SCROLL_NEVER}.
16205 *
16206 * @return This view's over-scroll mode.
16207 */
16208 public int getOverScrollMode() {
16209 return mOverScrollMode;
16210 }
16211
16212 /**
16213 * Set the over-scroll mode for this view. Valid over-scroll modes are
16214 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
16215 * (allow over-scrolling only if the view content is larger than the container),
16216 * or {@link #OVER_SCROLL_NEVER}.
16217 *
16218 * Setting the over-scroll mode of a view will have an effect only if the
16219 * view is capable of scrolling.
16220 *
16221 * @param overScrollMode The new over-scroll mode for this view.
16222 */
16223 public void setOverScrollMode(int overScrollMode) {
16224 if (overScrollMode != OVER_SCROLL_ALWAYS &&
16225 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS &&
16226 overScrollMode != OVER_SCROLL_NEVER) {
16227 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode);
16228 }
16229 mOverScrollMode = overScrollMode;
16230 }
16231
16232 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -080016233 * Gets a scale factor that determines the distance the view should scroll
16234 * vertically in response to {@link MotionEvent#ACTION_SCROLL}.
16235 * @return The vertical scroll scale factor.
16236 * @hide
16237 */
16238 protected float getVerticalScrollFactor() {
16239 if (mVerticalScrollFactor == 0) {
16240 TypedValue outValue = new TypedValue();
16241 if (!mContext.getTheme().resolveAttribute(
16242 com.android.internal.R.attr.listPreferredItemHeight, outValue, true)) {
16243 throw new IllegalStateException(
16244 "Expected theme to define listPreferredItemHeight.");
16245 }
16246 mVerticalScrollFactor = outValue.getDimension(
16247 mContext.getResources().getDisplayMetrics());
16248 }
16249 return mVerticalScrollFactor;
16250 }
16251
16252 /**
16253 * Gets a scale factor that determines the distance the view should scroll
16254 * horizontally in response to {@link MotionEvent#ACTION_SCROLL}.
16255 * @return The horizontal scroll scale factor.
16256 * @hide
16257 */
16258 protected float getHorizontalScrollFactor() {
16259 // TODO: Should use something else.
16260 return getVerticalScrollFactor();
16261 }
16262
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016263 /**
16264 * Return the value specifying the text direction or policy that was set with
16265 * {@link #setTextDirection(int)}.
16266 *
16267 * @return the defined text direction. It can be one of:
16268 *
16269 * {@link #TEXT_DIRECTION_INHERIT},
16270 * {@link #TEXT_DIRECTION_FIRST_STRONG}
16271 * {@link #TEXT_DIRECTION_ANY_RTL},
16272 * {@link #TEXT_DIRECTION_LTR},
16273 * {@link #TEXT_DIRECTION_RTL},
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016274 * {@link #TEXT_DIRECTION_LOCALE}
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016275 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016276 @ViewDebug.ExportedProperty(category = "text", mapping = {
16277 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"),
16278 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"),
16279 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"),
16280 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"),
16281 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL"),
16282 @ViewDebug.IntToString(from = TEXT_DIRECTION_LOCALE, to = "LOCALE")
16283 })
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016284 public int getTextDirection() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070016285 return (mPrivateFlags2 & PFLAG2_TEXT_DIRECTION_MASK) >> PFLAG2_TEXT_DIRECTION_MASK_SHIFT;
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016286 }
16287
16288 /**
16289 * Set the text direction.
16290 *
16291 * @param textDirection the direction to set. Should be one of:
16292 *
16293 * {@link #TEXT_DIRECTION_INHERIT},
16294 * {@link #TEXT_DIRECTION_FIRST_STRONG}
16295 * {@link #TEXT_DIRECTION_ANY_RTL},
16296 * {@link #TEXT_DIRECTION_LTR},
16297 * {@link #TEXT_DIRECTION_RTL},
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016298 * {@link #TEXT_DIRECTION_LOCALE}
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016299 */
16300 public void setTextDirection(int textDirection) {
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016301 if (getTextDirection() != textDirection) {
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -070016302 // Reset the current text direction and the resolved one
Dianne Hackborn4702a852012-08-17 15:18:29 -070016303 mPrivateFlags2 &= ~PFLAG2_TEXT_DIRECTION_MASK;
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -070016304 resetResolvedTextDirection();
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016305 // Set the new text direction
Dianne Hackborn4702a852012-08-17 15:18:29 -070016306 mPrivateFlags2 |= ((textDirection << PFLAG2_TEXT_DIRECTION_MASK_SHIFT) & PFLAG2_TEXT_DIRECTION_MASK);
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016307 // Refresh
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016308 requestLayout();
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -070016309 invalidate(true);
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016310 }
16311 }
16312
16313 /**
16314 * Return the resolved text direction.
16315 *
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016316 * This needs resolution if the value is TEXT_DIRECTION_INHERIT. The resolution matches
16317 * {@link #getTextDirection()}if it is not TEXT_DIRECTION_INHERIT, otherwise resolution proceeds
16318 * up the parent chain of the view. if there is no parent, then it will return the default
16319 * {@link #TEXT_DIRECTION_FIRST_STRONG}.
16320 *
16321 * @return the resolved text direction. Returns one of:
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016322 *
Doug Feltcb3791202011-07-07 11:57:48 -070016323 * {@link #TEXT_DIRECTION_FIRST_STRONG}
16324 * {@link #TEXT_DIRECTION_ANY_RTL},
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016325 * {@link #TEXT_DIRECTION_LTR},
16326 * {@link #TEXT_DIRECTION_RTL},
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016327 * {@link #TEXT_DIRECTION_LOCALE}
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016328 */
16329 public int getResolvedTextDirection() {
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070016330 // The text direction will be resolved only if needed
Dianne Hackborn4702a852012-08-17 15:18:29 -070016331 if ((mPrivateFlags2 & PFLAG2_TEXT_DIRECTION_RESOLVED) != PFLAG2_TEXT_DIRECTION_RESOLVED) {
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016332 resolveTextDirection();
16333 }
Dianne Hackborn4702a852012-08-17 15:18:29 -070016334 return (mPrivateFlags2 & PFLAG2_TEXT_DIRECTION_RESOLVED_MASK) >> PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT;
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016335 }
16336
16337 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016338 * Resolve the text direction. Will call {@link View#onResolvedTextDirectionChanged} when
16339 * resolution is done.
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016340 */
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016341 public void resolveTextDirection() {
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016342 // Reset any previous text direction resolution
Dianne Hackborn4702a852012-08-17 15:18:29 -070016343 mPrivateFlags2 &= ~(PFLAG2_TEXT_DIRECTION_RESOLVED | PFLAG2_TEXT_DIRECTION_RESOLVED_MASK);
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016344
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016345 if (hasRtlSupport()) {
16346 // Set resolved text direction flag depending on text direction flag
16347 final int textDirection = getTextDirection();
16348 switch(textDirection) {
16349 case TEXT_DIRECTION_INHERIT:
16350 if (canResolveTextDirection()) {
16351 ViewGroup viewGroup = ((ViewGroup) mParent);
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016352
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016353 // Set current resolved direction to the same value as the parent's one
16354 final int parentResolvedDirection = viewGroup.getResolvedTextDirection();
16355 switch (parentResolvedDirection) {
16356 case TEXT_DIRECTION_FIRST_STRONG:
16357 case TEXT_DIRECTION_ANY_RTL:
16358 case TEXT_DIRECTION_LTR:
16359 case TEXT_DIRECTION_RTL:
16360 case TEXT_DIRECTION_LOCALE:
16361 mPrivateFlags2 |=
Dianne Hackborn4702a852012-08-17 15:18:29 -070016362 (parentResolvedDirection << PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT);
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016363 break;
16364 default:
16365 // Default resolved direction is "first strong" heuristic
Dianne Hackborn4702a852012-08-17 15:18:29 -070016366 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT;
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016367 }
16368 } else {
16369 // We cannot do the resolution if there is no parent, so use the default one
Dianne Hackborn4702a852012-08-17 15:18:29 -070016370 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT;
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016371 }
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016372 break;
16373 case TEXT_DIRECTION_FIRST_STRONG:
16374 case TEXT_DIRECTION_ANY_RTL:
16375 case TEXT_DIRECTION_LTR:
16376 case TEXT_DIRECTION_RTL:
16377 case TEXT_DIRECTION_LOCALE:
16378 // Resolved direction is the same as text direction
Dianne Hackborn4702a852012-08-17 15:18:29 -070016379 mPrivateFlags2 |= (textDirection << PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT);
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016380 break;
16381 default:
16382 // Default resolved direction is "first strong" heuristic
Dianne Hackborn4702a852012-08-17 15:18:29 -070016383 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT;
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016384 }
16385 } else {
16386 // Default resolved direction is "first strong" heuristic
Dianne Hackborn4702a852012-08-17 15:18:29 -070016387 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT;
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016388 }
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016389
16390 // Set to resolved
Dianne Hackborn4702a852012-08-17 15:18:29 -070016391 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED;
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016392 onResolvedTextDirectionChanged();
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016393 }
16394
16395 /**
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016396 * Called when text direction has been resolved. Subclasses that care about text direction
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016397 * resolution should override this method.
16398 *
16399 * The default implementation does nothing.
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016400 */
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016401 public void onResolvedTextDirectionChanged() {
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016402 }
16403
16404 /**
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016405 * Check if text direction resolution can be done.
16406 *
16407 * @return true if text direction resolution can be done otherwise return false.
16408 */
16409 public boolean canResolveTextDirection() {
16410 switch (getTextDirection()) {
16411 case TEXT_DIRECTION_INHERIT:
16412 return (mParent != null) && (mParent instanceof ViewGroup);
16413 default:
16414 return true;
16415 }
16416 }
16417
16418 /**
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016419 * Reset resolved text direction. Text direction can be resolved with a call to
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016420 * getResolvedTextDirection(). Will call {@link View#onResolvedTextDirectionReset} when
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016421 * reset is done.
16422 */
16423 public void resetResolvedTextDirection() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070016424 mPrivateFlags2 &= ~(PFLAG2_TEXT_DIRECTION_RESOLVED | PFLAG2_TEXT_DIRECTION_RESOLVED_MASK);
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016425 onResolvedTextDirectionReset();
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016426 }
16427
16428 /**
16429 * Called when text direction is reset. Subclasses that care about text direction reset should
16430 * override this method and do a reset of the text direction of their children. The default
16431 * implementation does nothing.
16432 */
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016433 public void onResolvedTextDirectionReset() {
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016434 }
16435
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016436 /**
16437 * Return the value specifying the text alignment or policy that was set with
16438 * {@link #setTextAlignment(int)}.
16439 *
16440 * @return the defined text alignment. It can be one of:
16441 *
16442 * {@link #TEXT_ALIGNMENT_INHERIT},
16443 * {@link #TEXT_ALIGNMENT_GRAVITY},
16444 * {@link #TEXT_ALIGNMENT_CENTER},
16445 * {@link #TEXT_ALIGNMENT_TEXT_START},
16446 * {@link #TEXT_ALIGNMENT_TEXT_END},
16447 * {@link #TEXT_ALIGNMENT_VIEW_START},
16448 * {@link #TEXT_ALIGNMENT_VIEW_END}
16449 */
16450 @ViewDebug.ExportedProperty(category = "text", mapping = {
16451 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"),
16452 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"),
16453 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"),
16454 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"),
16455 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"),
16456 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"),
16457 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END")
16458 })
16459 public int getTextAlignment() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070016460 return (mPrivateFlags2 & PFLAG2_TEXT_ALIGNMENT_MASK) >> PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016461 }
16462
16463 /**
16464 * Set the text alignment.
16465 *
16466 * @param textAlignment The text alignment to set. Should be one of
16467 *
16468 * {@link #TEXT_ALIGNMENT_INHERIT},
16469 * {@link #TEXT_ALIGNMENT_GRAVITY},
16470 * {@link #TEXT_ALIGNMENT_CENTER},
16471 * {@link #TEXT_ALIGNMENT_TEXT_START},
16472 * {@link #TEXT_ALIGNMENT_TEXT_END},
16473 * {@link #TEXT_ALIGNMENT_VIEW_START},
16474 * {@link #TEXT_ALIGNMENT_VIEW_END}
16475 *
16476 * @attr ref android.R.styleable#View_textAlignment
16477 */
16478 public void setTextAlignment(int textAlignment) {
16479 if (textAlignment != getTextAlignment()) {
16480 // Reset the current and resolved text alignment
Dianne Hackborn4702a852012-08-17 15:18:29 -070016481 mPrivateFlags2 &= ~PFLAG2_TEXT_ALIGNMENT_MASK;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016482 resetResolvedTextAlignment();
16483 // Set the new text alignment
Dianne Hackborn4702a852012-08-17 15:18:29 -070016484 mPrivateFlags2 |= ((textAlignment << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT) & PFLAG2_TEXT_ALIGNMENT_MASK);
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016485 // Refresh
16486 requestLayout();
16487 invalidate(true);
16488 }
16489 }
16490
16491 /**
16492 * Return the resolved text alignment.
16493 *
16494 * The resolved text alignment. This needs resolution if the value is
16495 * TEXT_ALIGNMENT_INHERIT. The resolution matches {@link #setTextAlignment(int)} if it is
16496 * not TEXT_ALIGNMENT_INHERIT, otherwise resolution proceeds up the parent chain of the view.
16497 *
16498 * @return the resolved text alignment. Returns one of:
16499 *
16500 * {@link #TEXT_ALIGNMENT_GRAVITY},
16501 * {@link #TEXT_ALIGNMENT_CENTER},
16502 * {@link #TEXT_ALIGNMENT_TEXT_START},
16503 * {@link #TEXT_ALIGNMENT_TEXT_END},
16504 * {@link #TEXT_ALIGNMENT_VIEW_START},
16505 * {@link #TEXT_ALIGNMENT_VIEW_END}
16506 */
16507 @ViewDebug.ExportedProperty(category = "text", mapping = {
16508 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"),
16509 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"),
16510 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"),
16511 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"),
16512 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"),
16513 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"),
16514 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END")
16515 })
16516 public int getResolvedTextAlignment() {
16517 // If text alignment is not resolved, then resolve it
Dianne Hackborn4702a852012-08-17 15:18:29 -070016518 if ((mPrivateFlags2 & PFLAG2_TEXT_ALIGNMENT_RESOLVED) != PFLAG2_TEXT_ALIGNMENT_RESOLVED) {
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016519 resolveTextAlignment();
16520 }
Dianne Hackborn4702a852012-08-17 15:18:29 -070016521 return (mPrivateFlags2 & PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK) >> PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016522 }
16523
16524 /**
16525 * Resolve the text alignment. Will call {@link View#onResolvedTextAlignmentChanged} when
16526 * resolution is done.
16527 */
16528 public void resolveTextAlignment() {
16529 // Reset any previous text alignment resolution
Dianne Hackborn4702a852012-08-17 15:18:29 -070016530 mPrivateFlags2 &= ~(PFLAG2_TEXT_ALIGNMENT_RESOLVED | PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK);
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016531
16532 if (hasRtlSupport()) {
16533 // Set resolved text alignment flag depending on text alignment flag
16534 final int textAlignment = getTextAlignment();
16535 switch (textAlignment) {
16536 case TEXT_ALIGNMENT_INHERIT:
16537 // Check if we can resolve the text alignment
16538 if (canResolveLayoutDirection() && mParent instanceof View) {
16539 View view = (View) mParent;
16540
16541 final int parentResolvedTextAlignment = view.getResolvedTextAlignment();
16542 switch (parentResolvedTextAlignment) {
16543 case TEXT_ALIGNMENT_GRAVITY:
16544 case TEXT_ALIGNMENT_TEXT_START:
16545 case TEXT_ALIGNMENT_TEXT_END:
16546 case TEXT_ALIGNMENT_CENTER:
16547 case TEXT_ALIGNMENT_VIEW_START:
16548 case TEXT_ALIGNMENT_VIEW_END:
16549 // Resolved text alignment is the same as the parent resolved
16550 // text alignment
16551 mPrivateFlags2 |=
Dianne Hackborn4702a852012-08-17 15:18:29 -070016552 (parentResolvedTextAlignment << PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT);
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016553 break;
16554 default:
16555 // Use default resolved text alignment
Dianne Hackborn4702a852012-08-17 15:18:29 -070016556 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016557 }
16558 }
16559 else {
16560 // We cannot do the resolution if there is no parent so use the default
Dianne Hackborn4702a852012-08-17 15:18:29 -070016561 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016562 }
16563 break;
16564 case TEXT_ALIGNMENT_GRAVITY:
16565 case TEXT_ALIGNMENT_TEXT_START:
16566 case TEXT_ALIGNMENT_TEXT_END:
16567 case TEXT_ALIGNMENT_CENTER:
16568 case TEXT_ALIGNMENT_VIEW_START:
16569 case TEXT_ALIGNMENT_VIEW_END:
16570 // Resolved text alignment is the same as text alignment
Dianne Hackborn4702a852012-08-17 15:18:29 -070016571 mPrivateFlags2 |= (textAlignment << PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT);
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016572 break;
16573 default:
16574 // Use default resolved text alignment
Dianne Hackborn4702a852012-08-17 15:18:29 -070016575 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016576 }
16577 } else {
16578 // Use default resolved text alignment
Dianne Hackborn4702a852012-08-17 15:18:29 -070016579 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016580 }
16581
16582 // Set the resolved
Dianne Hackborn4702a852012-08-17 15:18:29 -070016583 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016584 onResolvedTextAlignmentChanged();
16585 }
16586
16587 /**
16588 * Check if text alignment resolution can be done.
16589 *
16590 * @return true if text alignment resolution can be done otherwise return false.
16591 */
16592 public boolean canResolveTextAlignment() {
16593 switch (getTextAlignment()) {
16594 case TEXT_DIRECTION_INHERIT:
16595 return (mParent != null);
16596 default:
16597 return true;
16598 }
16599 }
16600
16601 /**
16602 * Called when text alignment has been resolved. Subclasses that care about text alignment
16603 * resolution should override this method.
16604 *
16605 * The default implementation does nothing.
16606 */
16607 public void onResolvedTextAlignmentChanged() {
16608 }
16609
16610 /**
16611 * Reset resolved text alignment. Text alignment can be resolved with a call to
16612 * getResolvedTextAlignment(). Will call {@link View#onResolvedTextAlignmentReset} when
16613 * reset is done.
16614 */
16615 public void resetResolvedTextAlignment() {
16616 // Reset any previous text alignment resolution
Dianne Hackborn4702a852012-08-17 15:18:29 -070016617 mPrivateFlags2 &= ~(PFLAG2_TEXT_ALIGNMENT_RESOLVED | PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK);
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016618 onResolvedTextAlignmentReset();
16619 }
16620
16621 /**
16622 * Called when text alignment is reset. Subclasses that care about text alignment reset should
16623 * override this method and do a reset of the text alignment of their children. The default
16624 * implementation does nothing.
16625 */
16626 public void onResolvedTextAlignmentReset() {
16627 }
16628
Adam Powella9108a22012-07-18 11:18:09 -070016629 /**
16630 * Generate a value suitable for use in {@link #setId(int)}.
16631 * This value will not collide with ID values generated at build time by aapt for R.id.
16632 *
16633 * @return a generated ID value
16634 */
16635 public static int generateViewId() {
16636 for (;;) {
16637 final int result = sNextGeneratedId.get();
16638 // aapt-generated IDs have the high byte nonzero; clamp to the range under that.
16639 int newValue = result + 1;
16640 if (newValue > 0x00FFFFFF) newValue = 1; // Roll over to 1, not 0.
16641 if (sNextGeneratedId.compareAndSet(result, newValue)) {
16642 return result;
16643 }
16644 }
16645 }
16646
Chet Haaseb39f0512011-05-24 14:36:40 -070016647 //
16648 // Properties
16649 //
16650 /**
16651 * A Property wrapper around the <code>alpha</code> functionality handled by the
16652 * {@link View#setAlpha(float)} and {@link View#getAlpha()} methods.
16653 */
Chet Haased47f1532011-12-16 11:18:52 -080016654 public static final Property<View, Float> ALPHA = new FloatProperty<View>("alpha") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016655 @Override
16656 public void setValue(View object, float value) {
16657 object.setAlpha(value);
16658 }
16659
16660 @Override
16661 public Float get(View object) {
16662 return object.getAlpha();
16663 }
16664 };
16665
16666 /**
16667 * A Property wrapper around the <code>translationX</code> functionality handled by the
16668 * {@link View#setTranslationX(float)} and {@link View#getTranslationX()} methods.
16669 */
Chet Haased47f1532011-12-16 11:18:52 -080016670 public static final Property<View, Float> TRANSLATION_X = new FloatProperty<View>("translationX") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016671 @Override
16672 public void setValue(View object, float value) {
16673 object.setTranslationX(value);
16674 }
16675
16676 @Override
16677 public Float get(View object) {
16678 return object.getTranslationX();
16679 }
16680 };
16681
16682 /**
16683 * A Property wrapper around the <code>translationY</code> functionality handled by the
16684 * {@link View#setTranslationY(float)} and {@link View#getTranslationY()} methods.
16685 */
Chet Haased47f1532011-12-16 11:18:52 -080016686 public static final Property<View, Float> TRANSLATION_Y = new FloatProperty<View>("translationY") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016687 @Override
16688 public void setValue(View object, float value) {
16689 object.setTranslationY(value);
16690 }
16691
16692 @Override
16693 public Float get(View object) {
16694 return object.getTranslationY();
16695 }
16696 };
16697
16698 /**
16699 * A Property wrapper around the <code>x</code> functionality handled by the
16700 * {@link View#setX(float)} and {@link View#getX()} methods.
16701 */
Chet Haased47f1532011-12-16 11:18:52 -080016702 public static final Property<View, Float> X = new FloatProperty<View>("x") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016703 @Override
16704 public void setValue(View object, float value) {
16705 object.setX(value);
16706 }
16707
16708 @Override
16709 public Float get(View object) {
16710 return object.getX();
16711 }
16712 };
16713
16714 /**
16715 * A Property wrapper around the <code>y</code> functionality handled by the
16716 * {@link View#setY(float)} and {@link View#getY()} methods.
16717 */
Chet Haased47f1532011-12-16 11:18:52 -080016718 public static final Property<View, Float> Y = new FloatProperty<View>("y") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016719 @Override
16720 public void setValue(View object, float value) {
16721 object.setY(value);
16722 }
16723
16724 @Override
16725 public Float get(View object) {
16726 return object.getY();
16727 }
16728 };
16729
16730 /**
16731 * A Property wrapper around the <code>rotation</code> functionality handled by the
16732 * {@link View#setRotation(float)} and {@link View#getRotation()} methods.
16733 */
Chet Haased47f1532011-12-16 11:18:52 -080016734 public static final Property<View, Float> ROTATION = new FloatProperty<View>("rotation") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016735 @Override
16736 public void setValue(View object, float value) {
16737 object.setRotation(value);
16738 }
16739
16740 @Override
16741 public Float get(View object) {
16742 return object.getRotation();
16743 }
16744 };
16745
16746 /**
16747 * A Property wrapper around the <code>rotationX</code> functionality handled by the
16748 * {@link View#setRotationX(float)} and {@link View#getRotationX()} methods.
16749 */
Chet Haased47f1532011-12-16 11:18:52 -080016750 public static final Property<View, Float> ROTATION_X = new FloatProperty<View>("rotationX") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016751 @Override
16752 public void setValue(View object, float value) {
16753 object.setRotationX(value);
16754 }
16755
16756 @Override
16757 public Float get(View object) {
16758 return object.getRotationX();
16759 }
16760 };
16761
16762 /**
16763 * A Property wrapper around the <code>rotationY</code> functionality handled by the
16764 * {@link View#setRotationY(float)} and {@link View#getRotationY()} methods.
16765 */
Chet Haased47f1532011-12-16 11:18:52 -080016766 public static final Property<View, Float> ROTATION_Y = new FloatProperty<View>("rotationY") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016767 @Override
16768 public void setValue(View object, float value) {
16769 object.setRotationY(value);
16770 }
16771
16772 @Override
16773 public Float get(View object) {
16774 return object.getRotationY();
16775 }
16776 };
16777
16778 /**
16779 * A Property wrapper around the <code>scaleX</code> functionality handled by the
16780 * {@link View#setScaleX(float)} and {@link View#getScaleX()} methods.
16781 */
Chet Haased47f1532011-12-16 11:18:52 -080016782 public static final Property<View, Float> SCALE_X = new FloatProperty<View>("scaleX") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016783 @Override
16784 public void setValue(View object, float value) {
16785 object.setScaleX(value);
16786 }
16787
16788 @Override
16789 public Float get(View object) {
16790 return object.getScaleX();
16791 }
16792 };
16793
16794 /**
16795 * A Property wrapper around the <code>scaleY</code> functionality handled by the
16796 * {@link View#setScaleY(float)} and {@link View#getScaleY()} methods.
16797 */
Chet Haased47f1532011-12-16 11:18:52 -080016798 public static final Property<View, Float> SCALE_Y = new FloatProperty<View>("scaleY") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016799 @Override
16800 public void setValue(View object, float value) {
16801 object.setScaleY(value);
16802 }
16803
16804 @Override
16805 public Float get(View object) {
16806 return object.getScaleY();
16807 }
16808 };
16809
Jeff Brown33bbfd22011-02-24 20:55:35 -080016810 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016811 * A MeasureSpec encapsulates the layout requirements passed from parent to child.
16812 * Each MeasureSpec represents a requirement for either the width or the height.
16813 * A MeasureSpec is comprised of a size and a mode. There are three possible
16814 * modes:
16815 * <dl>
16816 * <dt>UNSPECIFIED</dt>
16817 * <dd>
16818 * The parent has not imposed any constraint on the child. It can be whatever size
16819 * it wants.
16820 * </dd>
16821 *
16822 * <dt>EXACTLY</dt>
16823 * <dd>
16824 * The parent has determined an exact size for the child. The child is going to be
16825 * given those bounds regardless of how big it wants to be.
16826 * </dd>
16827 *
16828 * <dt>AT_MOST</dt>
16829 * <dd>
16830 * The child can be as large as it wants up to the specified size.
16831 * </dd>
16832 * </dl>
16833 *
16834 * MeasureSpecs are implemented as ints to reduce object allocation. This class
16835 * is provided to pack and unpack the &lt;size, mode&gt; tuple into the int.
16836 */
16837 public static class MeasureSpec {
16838 private static final int MODE_SHIFT = 30;
16839 private static final int MODE_MASK = 0x3 << MODE_SHIFT;
16840
16841 /**
16842 * Measure specification mode: The parent has not imposed any constraint
16843 * on the child. It can be whatever size it wants.
16844 */
16845 public static final int UNSPECIFIED = 0 << MODE_SHIFT;
16846
16847 /**
16848 * Measure specification mode: The parent has determined an exact size
16849 * for the child. The child is going to be given those bounds regardless
16850 * of how big it wants to be.
16851 */
16852 public static final int EXACTLY = 1 << MODE_SHIFT;
16853
16854 /**
16855 * Measure specification mode: The child can be as large as it wants up
16856 * to the specified size.
16857 */
16858 public static final int AT_MOST = 2 << MODE_SHIFT;
16859
16860 /**
16861 * Creates a measure specification based on the supplied size and mode.
16862 *
16863 * The mode must always be one of the following:
16864 * <ul>
16865 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li>
16866 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li>
16867 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li>
16868 * </ul>
16869 *
16870 * @param size the size of the measure specification
16871 * @param mode the mode of the measure specification
16872 * @return the measure specification based on size and mode
16873 */
16874 public static int makeMeasureSpec(int size, int mode) {
16875 return size + mode;
16876 }
16877
16878 /**
16879 * Extracts the mode from the supplied measure specification.
16880 *
16881 * @param measureSpec the measure specification to extract the mode from
16882 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED},
16883 * {@link android.view.View.MeasureSpec#AT_MOST} or
16884 * {@link android.view.View.MeasureSpec#EXACTLY}
16885 */
16886 public static int getMode(int measureSpec) {
16887 return (measureSpec & MODE_MASK);
16888 }
16889
16890 /**
16891 * Extracts the size from the supplied measure specification.
16892 *
16893 * @param measureSpec the measure specification to extract the size from
16894 * @return the size in pixels defined in the supplied measure specification
16895 */
16896 public static int getSize(int measureSpec) {
16897 return (measureSpec & ~MODE_MASK);
16898 }
16899
16900 /**
16901 * Returns a String representation of the specified measure
16902 * specification.
16903 *
16904 * @param measureSpec the measure specification to convert to a String
16905 * @return a String with the following format: "MeasureSpec: MODE SIZE"
16906 */
16907 public static String toString(int measureSpec) {
16908 int mode = getMode(measureSpec);
16909 int size = getSize(measureSpec);
16910
16911 StringBuilder sb = new StringBuilder("MeasureSpec: ");
16912
16913 if (mode == UNSPECIFIED)
16914 sb.append("UNSPECIFIED ");
16915 else if (mode == EXACTLY)
16916 sb.append("EXACTLY ");
16917 else if (mode == AT_MOST)
16918 sb.append("AT_MOST ");
16919 else
16920 sb.append(mode).append(" ");
16921
16922 sb.append(size);
16923 return sb.toString();
16924 }
16925 }
16926
16927 class CheckForLongPress implements Runnable {
16928
16929 private int mOriginalWindowAttachCount;
16930
16931 public void run() {
The Android Open Source Project10592532009-03-18 17:39:46 -070016932 if (isPressed() && (mParent != null)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016933 && mOriginalWindowAttachCount == mWindowAttachCount) {
16934 if (performLongClick()) {
16935 mHasPerformedLongPress = true;
16936 }
16937 }
16938 }
16939
16940 public void rememberWindowAttachCount() {
16941 mOriginalWindowAttachCount = mWindowAttachCount;
16942 }
16943 }
Joe Malin32736f02011-01-19 16:14:20 -080016944
Adam Powelle14579b2009-12-16 18:39:52 -080016945 private final class CheckForTap implements Runnable {
16946 public void run() {
Dianne Hackborn4702a852012-08-17 15:18:29 -070016947 mPrivateFlags &= ~PFLAG_PREPRESSED;
Adam Powell4d6f0662012-02-21 15:11:11 -080016948 setPressed(true);
Patrick Dubroye0a799a2011-05-04 16:19:22 -070016949 checkForLongClick(ViewConfiguration.getTapTimeout());
Adam Powelle14579b2009-12-16 18:39:52 -080016950 }
16951 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016952
Adam Powella35d7682010-03-12 14:48:13 -080016953 private final class PerformClick implements Runnable {
16954 public void run() {
16955 performClick();
16956 }
16957 }
16958
Dianne Hackborn63042d62011-01-26 18:56:29 -080016959 /** @hide */
16960 public void hackTurnOffWindowResizeAnim(boolean off) {
16961 mAttachInfo.mTurnOffWindowResizeAnim = off;
16962 }
Joe Malin32736f02011-01-19 16:14:20 -080016963
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016964 /**
Chet Haasea00f3862011-02-22 06:34:40 -080016965 * This method returns a ViewPropertyAnimator object, which can be used to animate
16966 * specific properties on this View.
16967 *
16968 * @return ViewPropertyAnimator The ViewPropertyAnimator associated with this View.
16969 */
16970 public ViewPropertyAnimator animate() {
16971 if (mAnimator == null) {
16972 mAnimator = new ViewPropertyAnimator(this);
16973 }
16974 return mAnimator;
16975 }
16976
16977 /**
Jean Chalard405bc512012-05-29 19:12:34 +090016978 * Interface definition for a callback to be invoked when a hardware key event is
16979 * dispatched to this view. The callback will be invoked before the key event is
16980 * given to the view. This is only useful for hardware keyboards; a software input
16981 * method has no obligation to trigger this listener.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016982 */
16983 public interface OnKeyListener {
16984 /**
Jean Chalard405bc512012-05-29 19:12:34 +090016985 * Called when a hardware key is dispatched to a view. This allows listeners to
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016986 * get a chance to respond before the target view.
Jean Chalard405bc512012-05-29 19:12:34 +090016987 * <p>Key presses in software keyboards will generally NOT trigger this method,
16988 * although some may elect to do so in some situations. Do not assume a
16989 * software input method has to be key-based; even if it is, it may use key presses
16990 * in a different way than you expect, so there is no way to reliably catch soft
16991 * input key presses.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016992 *
16993 * @param v The view the key has been dispatched to.
16994 * @param keyCode The code for the physical key that was pressed
16995 * @param event The KeyEvent object containing full information about
16996 * the event.
16997 * @return True if the listener has consumed the event, false otherwise.
16998 */
16999 boolean onKey(View v, int keyCode, KeyEvent event);
17000 }
17001
17002 /**
17003 * Interface definition for a callback to be invoked when a touch event is
17004 * dispatched to this view. The callback will be invoked before the touch
17005 * event is given to the view.
17006 */
17007 public interface OnTouchListener {
17008 /**
17009 * Called when a touch event is dispatched to a view. This allows listeners to
17010 * get a chance to respond before the target view.
17011 *
17012 * @param v The view the touch event has been dispatched to.
17013 * @param event The MotionEvent object containing full information about
17014 * the event.
17015 * @return True if the listener has consumed the event, false otherwise.
17016 */
17017 boolean onTouch(View v, MotionEvent event);
17018 }
17019
17020 /**
Jeff Brown10b62902011-06-20 16:40:37 -070017021 * Interface definition for a callback to be invoked when a hover event is
17022 * dispatched to this view. The callback will be invoked before the hover
17023 * event is given to the view.
17024 */
17025 public interface OnHoverListener {
17026 /**
17027 * Called when a hover event is dispatched to a view. This allows listeners to
17028 * get a chance to respond before the target view.
17029 *
17030 * @param v The view the hover event has been dispatched to.
17031 * @param event The MotionEvent object containing full information about
17032 * the event.
17033 * @return True if the listener has consumed the event, false otherwise.
17034 */
17035 boolean onHover(View v, MotionEvent event);
17036 }
17037
17038 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -080017039 * Interface definition for a callback to be invoked when a generic motion event is
17040 * dispatched to this view. The callback will be invoked before the generic motion
17041 * event is given to the view.
17042 */
17043 public interface OnGenericMotionListener {
17044 /**
17045 * Called when a generic motion event is dispatched to a view. This allows listeners to
17046 * get a chance to respond before the target view.
17047 *
17048 * @param v The view the generic motion event has been dispatched to.
17049 * @param event The MotionEvent object containing full information about
17050 * the event.
17051 * @return True if the listener has consumed the event, false otherwise.
17052 */
17053 boolean onGenericMotion(View v, MotionEvent event);
17054 }
17055
17056 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017057 * Interface definition for a callback to be invoked when a view has been clicked and held.
17058 */
17059 public interface OnLongClickListener {
17060 /**
17061 * Called when a view has been clicked and held.
17062 *
17063 * @param v The view that was clicked and held.
17064 *
Brad Fitzpatrick69ea4e12011-01-05 11:13:40 -080017065 * @return true if the callback consumed the long click, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017066 */
17067 boolean onLongClick(View v);
17068 }
17069
17070 /**
Chris Tate32affef2010-10-18 15:29:21 -070017071 * Interface definition for a callback to be invoked when a drag is being dispatched
17072 * to this view. The callback will be invoked before the hosting view's own
17073 * onDrag(event) method. If the listener wants to fall back to the hosting view's
17074 * onDrag(event) behavior, it should return 'false' from this callback.
Joe Fernandez558459f2011-10-13 16:47:36 -070017075 *
17076 * <div class="special reference">
17077 * <h3>Developer Guides</h3>
17078 * <p>For a guide to implementing drag and drop features, read the
17079 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p>
17080 * </div>
Chris Tate32affef2010-10-18 15:29:21 -070017081 */
17082 public interface OnDragListener {
17083 /**
17084 * Called when a drag event is dispatched to a view. This allows listeners
17085 * to get a chance to override base View behavior.
17086 *
Joe Malin32736f02011-01-19 16:14:20 -080017087 * @param v The View that received the drag event.
17088 * @param event The {@link android.view.DragEvent} object for the drag event.
17089 * @return {@code true} if the drag event was handled successfully, or {@code false}
17090 * if the drag event was not handled. Note that {@code false} will trigger the View
17091 * to call its {@link #onDragEvent(DragEvent) onDragEvent()} handler.
Chris Tate32affef2010-10-18 15:29:21 -070017092 */
17093 boolean onDrag(View v, DragEvent event);
17094 }
17095
17096 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017097 * Interface definition for a callback to be invoked when the focus state of
17098 * a view changed.
17099 */
17100 public interface OnFocusChangeListener {
17101 /**
17102 * Called when the focus state of a view has changed.
17103 *
17104 * @param v The view whose state has changed.
17105 * @param hasFocus The new focus state of v.
17106 */
17107 void onFocusChange(View v, boolean hasFocus);
17108 }
17109
17110 /**
17111 * Interface definition for a callback to be invoked when a view is clicked.
17112 */
17113 public interface OnClickListener {
17114 /**
17115 * Called when a view has been clicked.
17116 *
17117 * @param v The view that was clicked.
17118 */
17119 void onClick(View v);
17120 }
17121
17122 /**
17123 * Interface definition for a callback to be invoked when the context menu
17124 * for this view is being built.
17125 */
17126 public interface OnCreateContextMenuListener {
17127 /**
17128 * Called when the context menu for this view is being built. It is not
17129 * safe to hold onto the menu after this method returns.
17130 *
17131 * @param menu The context menu that is being built
17132 * @param v The view for which the context menu is being built
17133 * @param menuInfo Extra information about the item for which the
17134 * context menu should be shown. This information will vary
17135 * depending on the class of v.
17136 */
17137 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo);
17138 }
17139
Joe Onorato664644d2011-01-23 17:53:23 -080017140 /**
17141 * Interface definition for a callback to be invoked when the status bar changes
Dianne Hackborn9a230e02011-10-06 11:51:27 -070017142 * visibility. This reports <strong>global</strong> changes to the system UI
Dianne Hackborncf675782012-05-10 15:07:24 -070017143 * state, not what the application is requesting.
Joe Onorato664644d2011-01-23 17:53:23 -080017144 *
Philip Milne6c8ea062012-04-03 17:38:43 -070017145 * @see View#setOnSystemUiVisibilityChangeListener(android.view.View.OnSystemUiVisibilityChangeListener)
Joe Onorato664644d2011-01-23 17:53:23 -080017146 */
17147 public interface OnSystemUiVisibilityChangeListener {
17148 /**
17149 * Called when the status bar changes visibility because of a call to
Romain Guy5c22a8c2011-05-13 11:48:45 -070017150 * {@link View#setSystemUiVisibility(int)}.
Joe Onorato664644d2011-01-23 17:53:23 -080017151 *
Dianne Hackborncf675782012-05-10 15:07:24 -070017152 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE},
17153 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, and {@link #SYSTEM_UI_FLAG_FULLSCREEN}.
17154 * This tells you the <strong>global</strong> state of these UI visibility
17155 * flags, not what your app is currently applying.
Joe Onorato664644d2011-01-23 17:53:23 -080017156 */
17157 public void onSystemUiVisibilityChange(int visibility);
17158 }
17159
Adam Powell4afd62b2011-02-18 15:02:18 -080017160 /**
17161 * Interface definition for a callback to be invoked when this view is attached
17162 * or detached from its window.
17163 */
17164 public interface OnAttachStateChangeListener {
17165 /**
17166 * Called when the view is attached to a window.
17167 * @param v The view that was attached
17168 */
17169 public void onViewAttachedToWindow(View v);
17170 /**
17171 * Called when the view is detached from a window.
17172 * @param v The view that was detached
17173 */
17174 public void onViewDetachedFromWindow(View v);
17175 }
17176
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017177 private final class UnsetPressedState implements Runnable {
17178 public void run() {
17179 setPressed(false);
17180 }
17181 }
17182
17183 /**
17184 * Base class for derived classes that want to save and restore their own
17185 * state in {@link android.view.View#onSaveInstanceState()}.
17186 */
17187 public static class BaseSavedState extends AbsSavedState {
17188 /**
17189 * Constructor used when reading from a parcel. Reads the state of the superclass.
17190 *
17191 * @param source
17192 */
17193 public BaseSavedState(Parcel source) {
17194 super(source);
17195 }
17196
17197 /**
17198 * Constructor called by derived classes when creating their SavedState objects
17199 *
17200 * @param superState The state of the superclass of this view
17201 */
17202 public BaseSavedState(Parcelable superState) {
17203 super(superState);
17204 }
17205
17206 public static final Parcelable.Creator<BaseSavedState> CREATOR =
17207 new Parcelable.Creator<BaseSavedState>() {
17208 public BaseSavedState createFromParcel(Parcel in) {
17209 return new BaseSavedState(in);
17210 }
17211
17212 public BaseSavedState[] newArray(int size) {
17213 return new BaseSavedState[size];
17214 }
17215 };
17216 }
17217
17218 /**
17219 * A set of information given to a view when it is attached to its parent
17220 * window.
17221 */
17222 static class AttachInfo {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017223 interface Callbacks {
17224 void playSoundEffect(int effectId);
17225 boolean performHapticFeedback(int effectId, boolean always);
17226 }
17227
17228 /**
17229 * InvalidateInfo is used to post invalidate(int, int, int, int) messages
17230 * to a Handler. This class contains the target (View) to invalidate and
17231 * the coordinates of the dirty rectangle.
17232 *
17233 * For performance purposes, this class also implements a pool of up to
17234 * POOL_LIMIT objects that get reused. This reduces memory allocations
17235 * whenever possible.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017236 */
Romain Guyd928d682009-03-31 17:52:16 -070017237 static class InvalidateInfo implements Poolable<InvalidateInfo> {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017238 private static final int POOL_LIMIT = 10;
Romain Guy2e9bbce2009-04-01 10:40:10 -070017239 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool(
17240 Pools.finitePool(new PoolableManager<InvalidateInfo>() {
Romain Guyd928d682009-03-31 17:52:16 -070017241 public InvalidateInfo newInstance() {
17242 return new InvalidateInfo();
17243 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017244
Romain Guyd928d682009-03-31 17:52:16 -070017245 public void onAcquired(InvalidateInfo element) {
17246 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017247
Romain Guyd928d682009-03-31 17:52:16 -070017248 public void onReleased(InvalidateInfo element) {
Romain Guy40c18f52011-09-01 17:01:18 -070017249 element.target = null;
Romain Guyd928d682009-03-31 17:52:16 -070017250 }
17251 }, POOL_LIMIT)
17252 );
17253
17254 private InvalidateInfo mNext;
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070017255 private boolean mIsPooled;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017256
17257 View target;
17258
17259 int left;
17260 int top;
17261 int right;
17262 int bottom;
17263
Romain Guyd928d682009-03-31 17:52:16 -070017264 public void setNextPoolable(InvalidateInfo element) {
17265 mNext = element;
17266 }
17267
17268 public InvalidateInfo getNextPoolable() {
17269 return mNext;
17270 }
17271
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017272 static InvalidateInfo acquire() {
Romain Guyd928d682009-03-31 17:52:16 -070017273 return sPool.acquire();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017274 }
17275
17276 void release() {
Romain Guyd928d682009-03-31 17:52:16 -070017277 sPool.release(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017278 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070017279
17280 public boolean isPooled() {
17281 return mIsPooled;
17282 }
17283
17284 public void setPooled(boolean isPooled) {
17285 mIsPooled = isPooled;
17286 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017287 }
17288
17289 final IWindowSession mSession;
17290
17291 final IWindow mWindow;
17292
17293 final IBinder mWindowToken;
17294
Jeff Brown98365d72012-08-19 20:30:52 -070017295 final Display mDisplay;
17296
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017297 final Callbacks mRootCallbacks;
17298
Romain Guy59a12ca2011-06-09 17:48:21 -070017299 HardwareCanvas mHardwareCanvas;
Chet Haasedaf98e92011-01-10 14:10:36 -080017300
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017301 /**
17302 * The top view of the hierarchy.
17303 */
17304 View mRootView;
Romain Guy8506ab42009-06-11 17:35:47 -070017305
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017306 IBinder mPanelParentWindowToken;
17307 Surface mSurface;
17308
Romain Guyb051e892010-09-28 19:09:36 -070017309 boolean mHardwareAccelerated;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080017310 boolean mHardwareAccelerationRequested;
Romain Guyb051e892010-09-28 19:09:36 -070017311 HardwareRenderer mHardwareRenderer;
Joe Malin32736f02011-01-19 16:14:20 -080017312
Romain Guy7e4e5612012-03-05 14:37:29 -080017313 boolean mScreenOn;
17314
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017315 /**
Romain Guy8506ab42009-06-11 17:35:47 -070017316 * Scale factor used by the compatibility mode
17317 */
17318 float mApplicationScale;
17319
17320 /**
17321 * Indicates whether the application is in compatibility mode
17322 */
17323 boolean mScalingRequired;
17324
17325 /**
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070017326 * If set, ViewAncestor doesn't use its lame animation for when the window resizes.
Dianne Hackborn63042d62011-01-26 18:56:29 -080017327 */
17328 boolean mTurnOffWindowResizeAnim;
Joe Malin32736f02011-01-19 16:14:20 -080017329
Dianne Hackborn63042d62011-01-26 18:56:29 -080017330 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017331 * Left position of this view's window
17332 */
17333 int mWindowLeft;
17334
17335 /**
17336 * Top position of this view's window
17337 */
17338 int mWindowTop;
17339
17340 /**
Adam Powell26153a32010-11-08 15:22:27 -080017341 * Indicates whether views need to use 32-bit drawing caches
Romain Guy35b38ce2009-10-07 13:38:55 -070017342 */
Adam Powell26153a32010-11-08 15:22:27 -080017343 boolean mUse32BitDrawingCache;
Romain Guy35b38ce2009-10-07 13:38:55 -070017344
17345 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017346 * For windows that are full-screen but using insets to layout inside
17347 * of the screen decorations, these are the current insets for the
17348 * content of the window.
17349 */
17350 final Rect mContentInsets = new Rect();
17351
17352 /**
17353 * For windows that are full-screen but using insets to layout inside
17354 * of the screen decorations, these are the current insets for the
17355 * actual visible parts of the window.
17356 */
17357 final Rect mVisibleInsets = new Rect();
17358
17359 /**
17360 * The internal insets given by this window. This value is
17361 * supplied by the client (through
17362 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will
17363 * be given to the window manager when changed to be used in laying
17364 * out windows behind it.
17365 */
17366 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets
17367 = new ViewTreeObserver.InternalInsetsInfo();
17368
17369 /**
17370 * All views in the window's hierarchy that serve as scroll containers,
17371 * used to determine if the window can be resized or must be panned
17372 * to adjust for a soft input area.
17373 */
17374 final ArrayList<View> mScrollContainers = new ArrayList<View>();
17375
Dianne Hackborn83fe3f52009-09-12 23:38:30 -070017376 final KeyEvent.DispatcherState mKeyDispatchState
17377 = new KeyEvent.DispatcherState();
17378
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017379 /**
17380 * Indicates whether the view's window currently has the focus.
17381 */
17382 boolean mHasWindowFocus;
17383
17384 /**
17385 * The current visibility of the window.
17386 */
17387 int mWindowVisibility;
17388
17389 /**
17390 * Indicates the time at which drawing started to occur.
17391 */
17392 long mDrawingTime;
17393
17394 /**
Romain Guy5bcdff42009-05-14 21:27:18 -070017395 * Indicates whether or not ignoring the DIRTY_MASK flags.
17396 */
17397 boolean mIgnoreDirtyState;
17398
17399 /**
Romain Guy02ccac62011-06-24 13:20:23 -070017400 * This flag tracks when the mIgnoreDirtyState flag is set during draw(),
17401 * to avoid clearing that flag prematurely.
17402 */
17403 boolean mSetIgnoreDirtyState = false;
17404
17405 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017406 * Indicates whether the view's window is currently in touch mode.
17407 */
17408 boolean mInTouchMode;
17409
17410 /**
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070017411 * Indicates that ViewAncestor should trigger a global layout change
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017412 * the next time it performs a traversal
17413 */
17414 boolean mRecomputeGlobalAttributes;
17415
17416 /**
Dianne Hackborn9a230e02011-10-06 11:51:27 -070017417 * Always report new attributes at next traversal.
17418 */
17419 boolean mForceReportNewAttributes;
17420
17421 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017422 * Set during a traveral if any views want to keep the screen on.
17423 */
17424 boolean mKeepScreenOn;
17425
17426 /**
Joe Onorato664644d2011-01-23 17:53:23 -080017427 * Bitwise-or of all of the values that views have passed to setSystemUiVisibility().
17428 */
17429 int mSystemUiVisibility;
17430
17431 /**
Dianne Hackborn139e5aa2012-05-05 20:36:38 -070017432 * Hack to force certain system UI visibility flags to be cleared.
17433 */
17434 int mDisabledSystemUiVisibility;
17435
17436 /**
Dianne Hackborncf675782012-05-10 15:07:24 -070017437 * Last global system UI visibility reported by the window manager.
17438 */
17439 int mGlobalSystemUiVisibility;
17440
17441 /**
Joe Onorato664644d2011-01-23 17:53:23 -080017442 * True if a view in this hierarchy has an OnSystemUiVisibilityChangeListener
17443 * attached.
17444 */
17445 boolean mHasSystemUiListeners;
17446
17447 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017448 * Set if the visibility of any views has changed.
17449 */
17450 boolean mViewVisibilityChanged;
17451
17452 /**
17453 * Set to true if a view has been scrolled.
17454 */
17455 boolean mViewScrollChanged;
17456
17457 /**
17458 * Global to the view hierarchy used as a temporary for dealing with
17459 * x/y points in the transparent region computations.
17460 */
17461 final int[] mTransparentLocation = new int[2];
17462
17463 /**
17464 * Global to the view hierarchy used as a temporary for dealing with
17465 * x/y points in the ViewGroup.invalidateChild implementation.
17466 */
17467 final int[] mInvalidateChildLocation = new int[2];
17468
Chet Haasec3aa3612010-06-17 08:50:37 -070017469
17470 /**
17471 * Global to the view hierarchy used as a temporary for dealing with
17472 * x/y location when view is transformed.
17473 */
17474 final float[] mTmpTransformLocation = new float[2];
17475
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017476 /**
17477 * The view tree observer used to dispatch global events like
17478 * layout, pre-draw, touch mode change, etc.
17479 */
17480 final ViewTreeObserver mTreeObserver = new ViewTreeObserver();
17481
17482 /**
17483 * A Canvas used by the view hierarchy to perform bitmap caching.
17484 */
17485 Canvas mCanvas;
17486
17487 /**
Jeff Browna175a5b2012-02-15 19:18:31 -080017488 * The view root impl.
17489 */
17490 final ViewRootImpl mViewRootImpl;
17491
17492 /**
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070017493 * A Handler supplied by a view's {@link android.view.ViewRootImpl}. This
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017494 * handler can be used to pump events in the UI events queue.
17495 */
17496 final Handler mHandler;
17497
17498 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017499 * Temporary for use in computing invalidate rectangles while
17500 * calling up the hierarchy.
17501 */
17502 final Rect mTmpInvalRect = new Rect();
svetoslavganov75986cf2009-05-14 22:28:01 -070017503
17504 /**
Chet Haasec3aa3612010-06-17 08:50:37 -070017505 * Temporary for use in computing hit areas with transformed views
17506 */
17507 final RectF mTmpTransformRect = new RectF();
17508
17509 /**
Chet Haase599913d2012-07-23 16:22:05 -070017510 * Temporary for use in transforming invalidation rect
17511 */
17512 final Matrix mTmpMatrix = new Matrix();
17513
17514 /**
17515 * Temporary for use in transforming invalidation rect
17516 */
17517 final Transformation mTmpTransformation = new Transformation();
17518
17519 /**
svetoslavganov75986cf2009-05-14 22:28:01 -070017520 * Temporary list for use in collecting focusable descendents of a view.
17521 */
Svetoslav Ganov42138042012-03-20 11:51:39 -070017522 final ArrayList<View> mTempArrayList = new ArrayList<View>(24);
svetoslavganov75986cf2009-05-14 22:28:01 -070017523
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017524 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070017525 * The id of the window for accessibility purposes.
17526 */
17527 int mAccessibilityWindowId = View.NO_ID;
17528
17529 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -070017530 * Whether to ingore not exposed for accessibility Views when
17531 * reporting the view tree to accessibility services.
17532 */
17533 boolean mIncludeNotImportantViews;
17534
17535 /**
17536 * The drawable for highlighting accessibility focus.
17537 */
17538 Drawable mAccessibilityFocusDrawable;
17539
17540 /**
Philip Milne10ca24a2012-04-23 15:38:27 -070017541 * Show where the margins, bounds and layout bounds are for each view.
17542 */
Dianne Hackborna53de062012-05-08 18:53:51 -070017543 boolean mDebugLayout = SystemProperties.getBoolean(DEBUG_LAYOUT_PROPERTY, false);
Philip Milne10ca24a2012-04-23 15:38:27 -070017544
17545 /**
Romain Guyab4c4f4f2012-05-06 13:11:24 -070017546 * Point used to compute visible regions.
17547 */
17548 final Point mPoint = new Point();
17549
17550 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017551 * Creates a new set of attachment information with the specified
17552 * events handler and thread.
17553 *
17554 * @param handler the events handler the view must use
17555 */
Jeff Brown98365d72012-08-19 20:30:52 -070017556 AttachInfo(IWindowSession session, IWindow window, Display display,
Jeff Browna175a5b2012-02-15 19:18:31 -080017557 ViewRootImpl viewRootImpl, Handler handler, Callbacks effectPlayer) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017558 mSession = session;
17559 mWindow = window;
17560 mWindowToken = window.asBinder();
Jeff Brown98365d72012-08-19 20:30:52 -070017561 mDisplay = display;
Jeff Browna175a5b2012-02-15 19:18:31 -080017562 mViewRootImpl = viewRootImpl;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017563 mHandler = handler;
17564 mRootCallbacks = effectPlayer;
17565 }
17566 }
17567
17568 /**
17569 * <p>ScrollabilityCache holds various fields used by a View when scrolling
17570 * is supported. This avoids keeping too many unused fields in most
17571 * instances of View.</p>
17572 */
Mike Cleronf116bf82009-09-27 19:14:12 -070017573 private static class ScrollabilityCache implements Runnable {
Joe Malin32736f02011-01-19 16:14:20 -080017574
Mike Cleronf116bf82009-09-27 19:14:12 -070017575 /**
17576 * Scrollbars are not visible
17577 */
17578 public static final int OFF = 0;
17579
17580 /**
17581 * Scrollbars are visible
17582 */
17583 public static final int ON = 1;
17584
17585 /**
17586 * Scrollbars are fading away
17587 */
17588 public static final int FADING = 2;
17589
17590 public boolean fadeScrollBars;
Joe Malin32736f02011-01-19 16:14:20 -080017591
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017592 public int fadingEdgeLength;
Mike Cleronf116bf82009-09-27 19:14:12 -070017593 public int scrollBarDefaultDelayBeforeFade;
17594 public int scrollBarFadeDuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017595
17596 public int scrollBarSize;
17597 public ScrollBarDrawable scrollBar;
Mike Cleronf116bf82009-09-27 19:14:12 -070017598 public float[] interpolatorValues;
17599 public View host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017600
17601 public final Paint paint;
17602 public final Matrix matrix;
17603 public Shader shader;
17604
Mike Cleronf116bf82009-09-27 19:14:12 -070017605 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2);
17606
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080017607 private static final float[] OPAQUE = { 255 };
17608 private static final float[] TRANSPARENT = { 0.0f };
Joe Malin32736f02011-01-19 16:14:20 -080017609
Mike Cleronf116bf82009-09-27 19:14:12 -070017610 /**
17611 * When fading should start. This time moves into the future every time
17612 * a new scroll happens. Measured based on SystemClock.uptimeMillis()
17613 */
17614 public long fadeStartTime;
17615
17616
17617 /**
17618 * The current state of the scrollbars: ON, OFF, or FADING
17619 */
17620 public int state = OFF;
17621
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017622 private int mLastColor;
17623
Mike Cleronf116bf82009-09-27 19:14:12 -070017624 public ScrollabilityCache(ViewConfiguration configuration, View host) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017625 fadingEdgeLength = configuration.getScaledFadingEdgeLength();
17626 scrollBarSize = configuration.getScaledScrollBarSize();
Romain Guy35b38ce2009-10-07 13:38:55 -070017627 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay();
17628 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017629
17630 paint = new Paint();
17631 matrix = new Matrix();
17632 // use use a height of 1, and then wack the matrix each time we
17633 // actually use it.
17634 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017635 paint.setShader(shader);
17636 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT));
Romain Guyd679b572012-08-29 21:49:00 -070017637
Mike Cleronf116bf82009-09-27 19:14:12 -070017638 this.host = host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017639 }
Romain Guy8506ab42009-06-11 17:35:47 -070017640
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017641 public void setFadeColor(int color) {
Romain Guyd679b572012-08-29 21:49:00 -070017642 if (color != mLastColor) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017643 mLastColor = color;
Romain Guy8506ab42009-06-11 17:35:47 -070017644
Romain Guyd679b572012-08-29 21:49:00 -070017645 if (color != 0) {
17646 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000,
17647 color & 0x00FFFFFF, Shader.TileMode.CLAMP);
17648 paint.setShader(shader);
17649 // Restore the default transfer mode (src_over)
17650 paint.setXfermode(null);
17651 } else {
17652 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP);
17653 paint.setShader(shader);
17654 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT));
17655 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017656 }
17657 }
Joe Malin32736f02011-01-19 16:14:20 -080017658
Mike Cleronf116bf82009-09-27 19:14:12 -070017659 public void run() {
Mike Cleron3ecd58c2009-09-28 11:39:02 -070017660 long now = AnimationUtils.currentAnimationTimeMillis();
Mike Cleronf116bf82009-09-27 19:14:12 -070017661 if (now >= fadeStartTime) {
17662
17663 // the animation fades the scrollbars out by changing
17664 // the opacity (alpha) from fully opaque to fully
17665 // transparent
17666 int nextFrame = (int) now;
17667 int framesCount = 0;
17668
17669 Interpolator interpolator = scrollBarInterpolator;
17670
17671 // Start opaque
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080017672 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE);
Mike Cleronf116bf82009-09-27 19:14:12 -070017673
17674 // End transparent
17675 nextFrame += scrollBarFadeDuration;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080017676 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT);
Mike Cleronf116bf82009-09-27 19:14:12 -070017677
17678 state = FADING;
17679
17680 // Kick off the fade animation
Romain Guy0fd89bf2011-01-26 15:41:30 -080017681 host.invalidate(true);
Mike Cleronf116bf82009-09-27 19:14:12 -070017682 }
17683 }
Svetoslav Ganova0156172011-06-26 17:55:44 -070017684 }
Mike Cleronf116bf82009-09-27 19:14:12 -070017685
Svetoslav Ganova0156172011-06-26 17:55:44 -070017686 /**
17687 * Resuable callback for sending
17688 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event.
17689 */
17690 private class SendViewScrolledAccessibilityEvent implements Runnable {
17691 public volatile boolean mIsPending;
17692
17693 public void run() {
17694 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_SCROLLED);
17695 mIsPending = false;
17696 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017697 }
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017698
17699 /**
17700 * <p>
17701 * This class represents a delegate that can be registered in a {@link View}
17702 * to enhance accessibility support via composition rather via inheritance.
17703 * It is specifically targeted to widget developers that extend basic View
17704 * classes i.e. classes in package android.view, that would like their
17705 * applications to be backwards compatible.
17706 * </p>
Joe Fernandeze1302ed2012-02-06 14:30:15 -080017707 * <div class="special reference">
17708 * <h3>Developer Guides</h3>
17709 * <p>For more information about making applications accessible, read the
17710 * <a href="{@docRoot}guide/topics/ui/accessibility/index.html">Accessibility</a>
17711 * developer guide.</p>
17712 * </div>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017713 * <p>
17714 * A scenario in which a developer would like to use an accessibility delegate
17715 * is overriding a method introduced in a later API version then the minimal API
17716 * version supported by the application. For example, the method
17717 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} is not available
17718 * in API version 4 when the accessibility APIs were first introduced. If a
17719 * developer would like his application to run on API version 4 devices (assuming
17720 * all other APIs used by the application are version 4 or lower) and take advantage
17721 * of this method, instead of overriding the method which would break the application's
17722 * backwards compatibility, he can override the corresponding method in this
17723 * delegate and register the delegate in the target View if the API version of
17724 * the system is high enough i.e. the API version is same or higher to the API
17725 * version that introduced
17726 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)}.
17727 * </p>
17728 * <p>
17729 * Here is an example implementation:
17730 * </p>
17731 * <code><pre><p>
17732 * if (Build.VERSION.SDK_INT >= 14) {
17733 * // If the API version is equal of higher than the version in
17734 * // which onInitializeAccessibilityNodeInfo was introduced we
17735 * // register a delegate with a customized implementation.
17736 * View view = findViewById(R.id.view_id);
17737 * view.setAccessibilityDelegate(new AccessibilityDelegate() {
17738 * public void onInitializeAccessibilityNodeInfo(View host,
17739 * AccessibilityNodeInfo info) {
17740 * // Let the default implementation populate the info.
17741 * super.onInitializeAccessibilityNodeInfo(host, info);
17742 * // Set some other information.
17743 * info.setEnabled(host.isEnabled());
17744 * }
17745 * });
17746 * }
17747 * </code></pre></p>
17748 * <p>
17749 * This delegate contains methods that correspond to the accessibility methods
17750 * in View. If a delegate has been specified the implementation in View hands
17751 * off handling to the corresponding method in this delegate. The default
17752 * implementation the delegate methods behaves exactly as the corresponding
17753 * method in View for the case of no accessibility delegate been set. Hence,
17754 * to customize the behavior of a View method, clients can override only the
17755 * corresponding delegate method without altering the behavior of the rest
17756 * accessibility related methods of the host view.
17757 * </p>
17758 */
17759 public static class AccessibilityDelegate {
17760
17761 /**
17762 * Sends an accessibility event of the given type. If accessibility is not
17763 * enabled this method has no effect.
17764 * <p>
17765 * The default implementation behaves as {@link View#sendAccessibilityEvent(int)
17766 * View#sendAccessibilityEvent(int)} for the case of no accessibility delegate
17767 * been set.
17768 * </p>
17769 *
17770 * @param host The View hosting the delegate.
17771 * @param eventType The type of the event to send.
17772 *
17773 * @see View#sendAccessibilityEvent(int) View#sendAccessibilityEvent(int)
17774 */
17775 public void sendAccessibilityEvent(View host, int eventType) {
17776 host.sendAccessibilityEventInternal(eventType);
17777 }
17778
17779 /**
alanv8eeefef2012-05-07 16:57:53 -070017780 * Performs the specified accessibility action on the view. For
17781 * possible accessibility actions look at {@link AccessibilityNodeInfo}.
17782 * <p>
17783 * The default implementation behaves as
17784 * {@link View#performAccessibilityAction(int, Bundle)
17785 * View#performAccessibilityAction(int, Bundle)} for the case of
17786 * no accessibility delegate been set.
17787 * </p>
17788 *
17789 * @param action The action to perform.
17790 * @return Whether the action was performed.
17791 *
17792 * @see View#performAccessibilityAction(int, Bundle)
17793 * View#performAccessibilityAction(int, Bundle)
17794 */
17795 public boolean performAccessibilityAction(View host, int action, Bundle args) {
17796 return host.performAccessibilityActionInternal(action, args);
17797 }
17798
17799 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017800 * Sends an accessibility event. This method behaves exactly as
17801 * {@link #sendAccessibilityEvent(View, int)} but takes as an argument an
17802 * empty {@link AccessibilityEvent} and does not perform a check whether
17803 * accessibility is enabled.
17804 * <p>
17805 * The default implementation behaves as
17806 * {@link View#sendAccessibilityEventUnchecked(AccessibilityEvent)
17807 * View#sendAccessibilityEventUnchecked(AccessibilityEvent)} for
17808 * the case of no accessibility delegate been set.
17809 * </p>
17810 *
17811 * @param host The View hosting the delegate.
17812 * @param event The event to send.
17813 *
17814 * @see View#sendAccessibilityEventUnchecked(AccessibilityEvent)
17815 * View#sendAccessibilityEventUnchecked(AccessibilityEvent)
17816 */
17817 public void sendAccessibilityEventUnchecked(View host, AccessibilityEvent event) {
17818 host.sendAccessibilityEventUncheckedInternal(event);
17819 }
17820
17821 /**
17822 * Dispatches an {@link AccessibilityEvent} to the host {@link View} first and then
17823 * to its children for adding their text content to the event.
17824 * <p>
17825 * The default implementation behaves as
17826 * {@link View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)
17827 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)} for
17828 * the case of no accessibility delegate been set.
17829 * </p>
17830 *
17831 * @param host The View hosting the delegate.
17832 * @param event The event.
17833 * @return True if the event population was completed.
17834 *
17835 * @see View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)
17836 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)
17837 */
17838 public boolean dispatchPopulateAccessibilityEvent(View host, AccessibilityEvent event) {
17839 return host.dispatchPopulateAccessibilityEventInternal(event);
17840 }
17841
17842 /**
17843 * Gives a chance to the host View to populate the accessibility event with its
17844 * text content.
17845 * <p>
17846 * The default implementation behaves as
17847 * {@link View#onPopulateAccessibilityEvent(AccessibilityEvent)
17848 * View#onPopulateAccessibilityEvent(AccessibilityEvent)} for
17849 * the case of no accessibility delegate been set.
17850 * </p>
17851 *
17852 * @param host The View hosting the delegate.
17853 * @param event The accessibility event which to populate.
17854 *
17855 * @see View#onPopulateAccessibilityEvent(AccessibilityEvent)
17856 * View#onPopulateAccessibilityEvent(AccessibilityEvent)
17857 */
17858 public void onPopulateAccessibilityEvent(View host, AccessibilityEvent event) {
17859 host.onPopulateAccessibilityEventInternal(event);
17860 }
17861
17862 /**
17863 * Initializes an {@link AccessibilityEvent} with information about the
17864 * the host View which is the event source.
17865 * <p>
17866 * The default implementation behaves as
17867 * {@link View#onInitializeAccessibilityEvent(AccessibilityEvent)
17868 * View#onInitializeAccessibilityEvent(AccessibilityEvent)} for
17869 * the case of no accessibility delegate been set.
17870 * </p>
17871 *
17872 * @param host The View hosting the delegate.
17873 * @param event The event to initialize.
17874 *
17875 * @see View#onInitializeAccessibilityEvent(AccessibilityEvent)
17876 * View#onInitializeAccessibilityEvent(AccessibilityEvent)
17877 */
17878 public void onInitializeAccessibilityEvent(View host, AccessibilityEvent event) {
17879 host.onInitializeAccessibilityEventInternal(event);
17880 }
17881
17882 /**
17883 * Initializes an {@link AccessibilityNodeInfo} with information about the host view.
17884 * <p>
17885 * The default implementation behaves as
17886 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
17887 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} for
17888 * the case of no accessibility delegate been set.
17889 * </p>
17890 *
17891 * @param host The View hosting the delegate.
17892 * @param info The instance to initialize.
17893 *
17894 * @see View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
17895 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
17896 */
17897 public void onInitializeAccessibilityNodeInfo(View host, AccessibilityNodeInfo info) {
17898 host.onInitializeAccessibilityNodeInfoInternal(info);
17899 }
17900
17901 /**
17902 * Called when a child of the host View has requested sending an
17903 * {@link AccessibilityEvent} and gives an opportunity to the parent (the host)
17904 * to augment the event.
17905 * <p>
17906 * The default implementation behaves as
17907 * {@link ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)
17908 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)} for
17909 * the case of no accessibility delegate been set.
17910 * </p>
17911 *
17912 * @param host The View hosting the delegate.
17913 * @param child The child which requests sending the event.
17914 * @param event The event to be sent.
17915 * @return True if the event should be sent
17916 *
17917 * @see ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)
17918 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)
17919 */
17920 public boolean onRequestSendAccessibilityEvent(ViewGroup host, View child,
17921 AccessibilityEvent event) {
17922 return host.onRequestSendAccessibilityEventInternal(child, event);
17923 }
Svetoslav Ganov02107852011-10-03 17:06:56 -070017924
17925 /**
17926 * Gets the provider for managing a virtual view hierarchy rooted at this View
17927 * and reported to {@link android.accessibilityservice.AccessibilityService}s
17928 * that explore the window content.
17929 * <p>
17930 * The default implementation behaves as
17931 * {@link View#getAccessibilityNodeProvider() View#getAccessibilityNodeProvider()} for
17932 * the case of no accessibility delegate been set.
17933 * </p>
17934 *
17935 * @return The provider.
17936 *
17937 * @see AccessibilityNodeProvider
17938 */
17939 public AccessibilityNodeProvider getAccessibilityNodeProvider(View host) {
17940 return null;
17941 }
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017942 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017943}