blob: 41890d6ee3d437c2d287409a1635d575377465c2 [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
Chet Haase21cd1382010-09-01 17:42:29 -070019import android.animation.LayoutTransition;
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.TypedArray;
23import android.graphics.Bitmap;
24import android.graphics.Canvas;
Philip Milne10ca24a2012-04-23 15:38:27 -070025import android.graphics.Color;
26import android.graphics.Insets;
Adam Powell6e346362010-07-23 10:18:23 -070027import android.graphics.Matrix;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080028import android.graphics.Paint;
Christopher Tatea53146c2010-09-07 11:57:52 -070029import android.graphics.PointF;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080030import android.graphics.Rect;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080031import android.graphics.RectF;
svetoslavganov75986cf2009-05-14 22:28:01 -070032import android.graphics.Region;
Jeff Brown995e7742010-12-22 16:59:36 -080033import android.os.Build;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080034import android.os.Parcelable;
35import android.os.SystemClock;
36import android.util.AttributeSet;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080037import android.util.Log;
38import android.util.SparseArray;
svetoslavganov75986cf2009-05-14 22:28:01 -070039import android.view.accessibility.AccessibilityEvent;
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070040import android.view.accessibility.AccessibilityNodeInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080041import android.view.animation.Animation;
42import android.view.animation.AnimationUtils;
43import android.view.animation.LayoutAnimationController;
44import android.view.animation.Transformation;
Doug Feltcb379122011-07-07 11:57:48 -070045
Romain Guy0211a0a2011-02-14 16:34:59 -080046import com.android.internal.R;
47import com.android.internal.util.Predicate;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080048
49import java.util.ArrayList;
Svetoslav Ganov42138042012-03-20 11:51:39 -070050import java.util.Collections;
Christopher Tate86cab1b2011-01-13 20:28:55 -080051import java.util.HashSet;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080052
53/**
54 * <p>
55 * A <code>ViewGroup</code> is a special view that can contain other views
56 * (called children.) The view group is the base class for layouts and views
57 * containers. This class also defines the
58 * {@link android.view.ViewGroup.LayoutParams} class which serves as the base
59 * class for layouts parameters.
60 * </p>
61 *
62 * <p>
63 * Also see {@link LayoutParams} for layout attributes.
64 * </p>
Romain Guyd6a463a2009-05-21 23:10:10 -070065 *
Joe Fernandez558459f2011-10-13 16:47:36 -070066 * <div class="special reference">
67 * <h3>Developer Guides</h3>
68 * <p>For more information about creating user interface layouts, read the
69 * <a href="{@docRoot}guide/topics/ui/declaring-layout.html">XML Layouts</a> developer
70 * guide.</p></div>
71 *
Romain Guyd6a463a2009-05-21 23:10:10 -070072 * @attr ref android.R.styleable#ViewGroup_clipChildren
73 * @attr ref android.R.styleable#ViewGroup_clipToPadding
74 * @attr ref android.R.styleable#ViewGroup_layoutAnimation
75 * @attr ref android.R.styleable#ViewGroup_animationCache
76 * @attr ref android.R.styleable#ViewGroup_persistentDrawingCache
77 * @attr ref android.R.styleable#ViewGroup_alwaysDrawnWithCache
78 * @attr ref android.R.styleable#ViewGroup_addStatesFromChildren
79 * @attr ref android.R.styleable#ViewGroup_descendantFocusability
Chet Haase13cc1202010-09-03 15:39:20 -070080 * @attr ref android.R.styleable#ViewGroup_animateLayoutChanges
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080081 */
82public abstract class ViewGroup extends View implements ViewParent, ViewManager {
Adam Powell539ee872012-02-03 19:00:49 -080083 private static final String TAG = "ViewGroup";
Chet Haase21cd1382010-09-01 17:42:29 -070084
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080085 private static final boolean DBG = false;
Gilles Debunnecea45132011-11-24 02:19:27 +010086
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080087 /**
88 * Views which have been hidden or removed which need to be animated on
89 * their way out.
90 * This field should be made private, so it is hidden from the SDK.
91 * {@hide}
92 */
93 protected ArrayList<View> mDisappearingChildren;
94
95 /**
96 * Listener used to propagate events indicating when children are added
97 * and/or removed from a view group.
98 * This field should be made private, so it is hidden from the SDK.
99 * {@hide}
100 */
101 protected OnHierarchyChangeListener mOnHierarchyChangeListener;
102
103 // The view contained within this ViewGroup that has or contains focus.
104 private View mFocused;
105
Chet Haase48460322010-06-11 14:22:25 -0700106 /**
107 * A Transformation used when drawing children, to
108 * apply on the child being drawn.
109 */
Chet Haase64a48c12012-02-13 16:33:29 -0800110 final Transformation mChildTransformation = new Transformation();
Chet Haase48460322010-06-11 14:22:25 -0700111
112 /**
113 * Used to track the current invalidation region.
114 */
Chet Haase64a48c12012-02-13 16:33:29 -0800115 RectF mInvalidateRegion;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800116
Chet Haase48460322010-06-11 14:22:25 -0700117 /**
118 * A Transformation used to calculate a correct
119 * invalidation area when the application is autoscaled.
120 */
Chet Haase64a48c12012-02-13 16:33:29 -0800121 Transformation mInvalidationTransformation;
Chet Haase48460322010-06-11 14:22:25 -0700122
Christopher Tatea53146c2010-09-07 11:57:52 -0700123 // View currently under an ongoing drag
124 private View mCurrentDragView;
125
Christopher Tate86cab1b2011-01-13 20:28:55 -0800126 // Metadata about the ongoing drag
127 private DragEvent mCurrentDrag;
128 private HashSet<View> mDragNotifiedChildren;
129
Christopher Tatea53146c2010-09-07 11:57:52 -0700130 // Does this group have a child that can accept the current drag payload?
131 private boolean mChildAcceptsDrag;
132
133 // Used during drag dispatch
134 private final PointF mLocalPoint = new PointF();
135
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800136 // Layout animation
137 private LayoutAnimationController mLayoutAnimationController;
138 private Animation.AnimationListener mAnimationListener;
139
Jeff Brown20e987b2010-08-23 12:01:02 -0700140 // First touch target in the linked list of touch targets.
141 private TouchTarget mFirstTouchTarget;
142
Joe Onorato03ab0c72011-01-06 15:46:27 -0800143 // For debugging only. You can see these in hierarchyviewer.
Romain Guye95003e2011-01-09 13:53:06 -0800144 @SuppressWarnings({"FieldCanBeLocal", "UnusedDeclaration"})
Joe Onorato03ab0c72011-01-06 15:46:27 -0800145 @ViewDebug.ExportedProperty(category = "events")
146 private long mLastTouchDownTime;
147 @ViewDebug.ExportedProperty(category = "events")
148 private int mLastTouchDownIndex = -1;
Romain Guye95003e2011-01-09 13:53:06 -0800149 @SuppressWarnings({"FieldCanBeLocal", "UnusedDeclaration"})
Joe Onorato03ab0c72011-01-06 15:46:27 -0800150 @ViewDebug.ExportedProperty(category = "events")
151 private float mLastTouchDownX;
Romain Guye95003e2011-01-09 13:53:06 -0800152 @SuppressWarnings({"FieldCanBeLocal", "UnusedDeclaration"})
Joe Onorato03ab0c72011-01-06 15:46:27 -0800153 @ViewDebug.ExportedProperty(category = "events")
154 private float mLastTouchDownY;
155
Jeff Brown87b7f802011-06-21 18:35:45 -0700156 // First hover target in the linked list of hover targets.
157 // The hover targets are children which have received ACTION_HOVER_ENTER.
158 // They might not have actually handled the hover event, but we will
159 // continue sending hover events to them as long as the pointer remains over
160 // their bounds and the view group does not intercept hover.
161 private HoverTarget mFirstHoverTarget;
Jeff Browna032cc02011-03-07 16:56:21 -0800162
Jeff Brown10b62902011-06-20 16:40:37 -0700163 // True if the view group itself received a hover event.
164 // It might not have actually handled the hover event.
165 private boolean mHoveredSelf;
166
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800167 /**
168 * Internal flags.
Romain Guy8506ab42009-06-11 17:35:47 -0700169 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800170 * This field should be made private, so it is hidden from the SDK.
171 * {@hide}
172 */
Romain Guy2440e672012-08-07 14:43:43 -0700173 @ViewDebug.ExportedProperty(flagMapping = {
174 @ViewDebug.FlagToString(mask = FLAG_CLIP_CHILDREN, equals = FLAG_CLIP_CHILDREN,
175 name = "CLIP_CHILDREN"),
176 @ViewDebug.FlagToString(mask = FLAG_CLIP_TO_PADDING, equals = FLAG_CLIP_TO_PADDING,
177 name = "CLIP_TO_PADDING"),
178 @ViewDebug.FlagToString(mask = FLAG_PADDING_NOT_NULL, equals = FLAG_PADDING_NOT_NULL,
179 name = "PADDING_NOT_NULL")
180 })
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800181 protected int mGroupFlags;
182
Philip Milne1557fd72012-04-04 23:41:34 -0700183 /*
Philip Milne7a23b492012-04-24 22:12:36 -0700184 * The layout mode: either {@link #CLIP_BOUNDS} or {@link #OPTICAL_BOUNDS}
Philip Milne1557fd72012-04-04 23:41:34 -0700185 */
Philip Milne7a23b492012-04-24 22:12:36 -0700186 private int mLayoutMode = CLIP_BOUNDS;
Philip Milne1557fd72012-04-04 23:41:34 -0700187
Romain Guy33f6beb2012-02-16 19:24:51 -0800188 /**
189 * NOTE: If you change the flags below make sure to reflect the changes
190 * the DisplayList class
191 */
192
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800193 // When set, ViewGroup invalidates only the child's rectangle
194 // Set by default
Chet Haase64a48c12012-02-13 16:33:29 -0800195 static final int FLAG_CLIP_CHILDREN = 0x1;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800196
197 // When set, ViewGroup excludes the padding area from the invalidate rectangle
198 // Set by default
199 private static final int FLAG_CLIP_TO_PADDING = 0x2;
200
201 // When set, dispatchDraw() will invoke invalidate(); this is set by drawChild() when
202 // a child needs to be invalidated and FLAG_OPTIMIZE_INVALIDATE is set
Chet Haase64a48c12012-02-13 16:33:29 -0800203 static final int FLAG_INVALIDATE_REQUIRED = 0x4;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800204
205 // When set, dispatchDraw() will run the layout animation and unset the flag
206 private static final int FLAG_RUN_ANIMATION = 0x8;
207
208 // When set, there is either no layout animation on the ViewGroup or the layout
209 // animation is over
210 // Set by default
Chet Haase64a48c12012-02-13 16:33:29 -0800211 static final int FLAG_ANIMATION_DONE = 0x10;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800212
213 // If set, this ViewGroup has padding; if unset there is no padding and we don't need
214 // to clip it, even if FLAG_CLIP_TO_PADDING is set
215 private static final int FLAG_PADDING_NOT_NULL = 0x20;
216
217 // When set, this ViewGroup caches its children in a Bitmap before starting a layout animation
218 // Set by default
219 private static final int FLAG_ANIMATION_CACHE = 0x40;
220
221 // When set, this ViewGroup converts calls to invalidate(Rect) to invalidate() during a
222 // layout animation; this avoid clobbering the hierarchy
223 // Automatically set when the layout animation starts, depending on the animation's
224 // characteristics
Chet Haase64a48c12012-02-13 16:33:29 -0800225 static final int FLAG_OPTIMIZE_INVALIDATE = 0x80;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800226
227 // When set, the next call to drawChild() will clear mChildTransformation's matrix
Chet Haase64a48c12012-02-13 16:33:29 -0800228 static final int FLAG_CLEAR_TRANSFORMATION = 0x100;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800229
230 // When set, this ViewGroup invokes mAnimationListener.onAnimationEnd() and removes
231 // the children's Bitmap caches if necessary
232 // This flag is set when the layout animation is over (after FLAG_ANIMATION_DONE is set)
233 private static final int FLAG_NOTIFY_ANIMATION_LISTENER = 0x200;
234
235 /**
236 * When set, the drawing method will call {@link #getChildDrawingOrder(int, int)}
237 * to get the index of the child to draw for that iteration.
Romain Guy293451e2009-11-04 13:59:48 -0800238 *
239 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800240 */
241 protected static final int FLAG_USE_CHILD_DRAWING_ORDER = 0x400;
Romain Guy8506ab42009-06-11 17:35:47 -0700242
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800243 /**
244 * When set, this ViewGroup supports static transformations on children; this causes
245 * {@link #getChildStaticTransformation(View, android.view.animation.Transformation)} to be
246 * invoked when a child is drawn.
247 *
248 * Any subclass overriding
249 * {@link #getChildStaticTransformation(View, android.view.animation.Transformation)} should
250 * set this flags in {@link #mGroupFlags}.
Romain Guy8506ab42009-06-11 17:35:47 -0700251 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800252 * {@hide}
253 */
254 protected static final int FLAG_SUPPORT_STATIC_TRANSFORMATIONS = 0x800;
255
256 // When the previous drawChild() invocation used an alpha value that was lower than
257 // 1.0 and set it in mCachePaint
Chet Haase64a48c12012-02-13 16:33:29 -0800258 static final int FLAG_ALPHA_LOWER_THAN_ONE = 0x1000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800259
260 /**
261 * When set, this ViewGroup's drawable states also include those
262 * of its children.
263 */
264 private static final int FLAG_ADD_STATES_FROM_CHILDREN = 0x2000;
265
266 /**
267 * When set, this ViewGroup tries to always draw its children using their drawing cache.
268 */
Chet Haase64a48c12012-02-13 16:33:29 -0800269 static final int FLAG_ALWAYS_DRAWN_WITH_CACHE = 0x4000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800270
271 /**
272 * When set, and if FLAG_ALWAYS_DRAWN_WITH_CACHE is not set, this ViewGroup will try to
273 * draw its children with their drawing cache.
274 */
Chet Haase64a48c12012-02-13 16:33:29 -0800275 static final int FLAG_CHILDREN_DRAWN_WITH_CACHE = 0x8000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800276
277 /**
278 * When set, this group will go through its list of children to notify them of
279 * any drawable state change.
280 */
281 private static final int FLAG_NOTIFY_CHILDREN_ON_DRAWABLE_STATE_CHANGE = 0x10000;
282
283 private static final int FLAG_MASK_FOCUSABILITY = 0x60000;
284
285 /**
286 * This view will get focus before any of its descendants.
287 */
288 public static final int FOCUS_BEFORE_DESCENDANTS = 0x20000;
289
290 /**
291 * This view will get focus only if none of its descendants want it.
292 */
293 public static final int FOCUS_AFTER_DESCENDANTS = 0x40000;
294
295 /**
296 * This view will block any of its descendants from getting focus, even
297 * if they are focusable.
298 */
299 public static final int FOCUS_BLOCK_DESCENDANTS = 0x60000;
300
301 /**
302 * Used to map between enum in attrubutes and flag values.
303 */
304 private static final int[] DESCENDANT_FOCUSABILITY_FLAGS =
305 {FOCUS_BEFORE_DESCENDANTS, FOCUS_AFTER_DESCENDANTS,
306 FOCUS_BLOCK_DESCENDANTS};
307
308 /**
309 * When set, this ViewGroup should not intercept touch events.
Adam Powell110486f2010-06-22 17:14:44 -0700310 * {@hide}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800311 */
Adam Powell110486f2010-06-22 17:14:44 -0700312 protected static final int FLAG_DISALLOW_INTERCEPT = 0x80000;
Romain Guy8506ab42009-06-11 17:35:47 -0700313
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800314 /**
Adam Powell2b342f02010-08-18 18:14:13 -0700315 * When set, this ViewGroup will split MotionEvents to multiple child Views when appropriate.
316 */
Adam Powellf37df072010-09-17 16:22:49 -0700317 private static final int FLAG_SPLIT_MOTION_EVENTS = 0x200000;
Adam Powell2b342f02010-08-18 18:14:13 -0700318
319 /**
Adam Powell4b867882011-09-16 12:59:46 -0700320 * When set, this ViewGroup will not dispatch onAttachedToWindow calls
321 * to children when adding new views. This is used to prevent multiple
322 * onAttached calls when a ViewGroup adds children in its own onAttached method.
323 */
324 private static final int FLAG_PREVENT_DISPATCH_ATTACHED_TO_WINDOW = 0x400000;
325
326 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800327 * Indicates which types of drawing caches are to be kept in memory.
328 * This field should be made private, so it is hidden from the SDK.
329 * {@hide}
330 */
331 protected int mPersistentDrawingCache;
332
333 /**
334 * Used to indicate that no drawing cache should be kept in memory.
335 */
336 public static final int PERSISTENT_NO_CACHE = 0x0;
337
338 /**
339 * Used to indicate that the animation drawing cache should be kept in memory.
340 */
341 public static final int PERSISTENT_ANIMATION_CACHE = 0x1;
342
343 /**
344 * Used to indicate that the scrolling drawing cache should be kept in memory.
345 */
346 public static final int PERSISTENT_SCROLLING_CACHE = 0x2;
347
348 /**
349 * Used to indicate that all drawing caches should be kept in memory.
350 */
351 public static final int PERSISTENT_ALL_CACHES = 0x3;
352
Philip Milne1557fd72012-04-04 23:41:34 -0700353 // Layout Modes
354
Philip Milne1557fd72012-04-04 23:41:34 -0700355 /**
356 * This constant is a {@link #setLayoutMode(int) layoutMode}.
Philip Milne7a23b492012-04-24 22:12:36 -0700357 * Clip bounds are the raw values of {@link #getLeft() left}, {@link #getTop() top},
Philip Milne1557fd72012-04-04 23:41:34 -0700358 * {@link #getRight() right} and {@link #getBottom() bottom}.
Philip Milne7bb66c92012-05-07 11:42:57 -0700359 *
360 * @hide
Philip Milne1557fd72012-04-04 23:41:34 -0700361 */
Philip Milne7a23b492012-04-24 22:12:36 -0700362 public static final int CLIP_BOUNDS = 0;
Philip Milne1557fd72012-04-04 23:41:34 -0700363
364 /**
365 * This constant is a {@link #setLayoutMode(int) layoutMode}.
Philip Milne7a23b492012-04-24 22:12:36 -0700366 * Optical bounds describe where a widget appears to be. They sit inside the clip
367 * bounds which need to cover a larger area to allow other effects,
368 * such as shadows and glows, to be drawn.
Philip Milne7bb66c92012-05-07 11:42:57 -0700369 *
370 * @hide
Philip Milne1557fd72012-04-04 23:41:34 -0700371 */
Philip Milne7a23b492012-04-24 22:12:36 -0700372 public static final int OPTICAL_BOUNDS = 1;
Philip Milne1557fd72012-04-04 23:41:34 -0700373
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800374 /**
375 * We clip to padding when FLAG_CLIP_TO_PADDING and FLAG_PADDING_NOT_NULL
376 * are set at the same time.
377 */
378 protected static final int CLIP_TO_PADDING_MASK = FLAG_CLIP_TO_PADDING | FLAG_PADDING_NOT_NULL;
379
380 // Index of the child's left position in the mLocation array
381 private static final int CHILD_LEFT_INDEX = 0;
382 // Index of the child's top position in the mLocation array
383 private static final int CHILD_TOP_INDEX = 1;
384
385 // Child views of this ViewGroup
386 private View[] mChildren;
387 // Number of valid children in the mChildren array, the rest should be null or not
388 // considered as children
Chet Haase9c087442011-01-12 16:20:16 -0800389
390 private boolean mLayoutSuppressed = false;
391
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800392 private int mChildrenCount;
393
394 private static final int ARRAY_INITIAL_CAPACITY = 12;
395 private static final int ARRAY_CAPACITY_INCREMENT = 12;
396
Romain Guycbc67742012-04-27 16:12:57 -0700397 private static Paint sDebugPaint;
398 private static float[] sDebugLines;
Philip Milne604f4402012-04-24 19:27:11 -0700399
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800400 // Used to draw cached views
Chet Haase64a48c12012-02-13 16:33:29 -0800401 Paint mCachePaint;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800402
Chet Haase21cd1382010-09-01 17:42:29 -0700403 // Used to animate add/remove changes in layout
404 private LayoutTransition mTransition;
405
406 // The set of views that are currently being transitioned. This list is used to track views
407 // being removed that should not actually be removed from the parent yet because they are
408 // being animated.
409 private ArrayList<View> mTransitioningViews;
410
Chet Haase5e25c2c2010-09-16 11:15:56 -0700411 // List of children changing visibility. This is used to potentially keep rendering
412 // views during a transition when they otherwise would have become gone/invisible
413 private ArrayList<View> mVisibilityChangingChildren;
414
Adam Powell539ee872012-02-03 19:00:49 -0800415 // Indicates how many of this container's child subtrees contain transient state
416 @ViewDebug.ExportedProperty(category = "layout")
417 private int mChildCountWithTransientState = 0;
418
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800419 public ViewGroup(Context context) {
420 super(context);
421 initViewGroup();
422 }
423
424 public ViewGroup(Context context, AttributeSet attrs) {
425 super(context, attrs);
426 initViewGroup();
427 initFromAttributes(context, attrs);
428 }
429
430 public ViewGroup(Context context, AttributeSet attrs, int defStyle) {
431 super(context, attrs, defStyle);
432 initViewGroup();
433 initFromAttributes(context, attrs);
434 }
435
Philip Milne10ca24a2012-04-23 15:38:27 -0700436 private boolean debugDraw() {
437 return mAttachInfo != null && mAttachInfo.mDebugLayout;
438 }
439
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800440 private void initViewGroup() {
441 // ViewGroup doesn't draw by default
Philip Milne10ca24a2012-04-23 15:38:27 -0700442 if (!debugDraw()) {
443 setFlags(WILL_NOT_DRAW, DRAW_MASK);
444 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800445 mGroupFlags |= FLAG_CLIP_CHILDREN;
446 mGroupFlags |= FLAG_CLIP_TO_PADDING;
447 mGroupFlags |= FLAG_ANIMATION_DONE;
448 mGroupFlags |= FLAG_ANIMATION_CACHE;
449 mGroupFlags |= FLAG_ALWAYS_DRAWN_WITH_CACHE;
450
Jeff Brown995e7742010-12-22 16:59:36 -0800451 if (mContext.getApplicationInfo().targetSdkVersion >= Build.VERSION_CODES.HONEYCOMB) {
452 mGroupFlags |= FLAG_SPLIT_MOTION_EVENTS;
453 }
454
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800455 setDescendantFocusability(FOCUS_BEFORE_DESCENDANTS);
456
457 mChildren = new View[ARRAY_INITIAL_CAPACITY];
458 mChildrenCount = 0;
459
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800460 mPersistentDrawingCache = PERSISTENT_SCROLLING_CACHE;
461 }
462
463 private void initFromAttributes(Context context, AttributeSet attrs) {
464 TypedArray a = context.obtainStyledAttributes(attrs,
465 R.styleable.ViewGroup);
466
467 final int N = a.getIndexCount();
468 for (int i = 0; i < N; i++) {
469 int attr = a.getIndex(i);
470 switch (attr) {
471 case R.styleable.ViewGroup_clipChildren:
472 setClipChildren(a.getBoolean(attr, true));
473 break;
474 case R.styleable.ViewGroup_clipToPadding:
475 setClipToPadding(a.getBoolean(attr, true));
476 break;
477 case R.styleable.ViewGroup_animationCache:
478 setAnimationCacheEnabled(a.getBoolean(attr, true));
479 break;
480 case R.styleable.ViewGroup_persistentDrawingCache:
481 setPersistentDrawingCache(a.getInt(attr, PERSISTENT_SCROLLING_CACHE));
482 break;
483 case R.styleable.ViewGroup_addStatesFromChildren:
484 setAddStatesFromChildren(a.getBoolean(attr, false));
485 break;
486 case R.styleable.ViewGroup_alwaysDrawnWithCache:
487 setAlwaysDrawnWithCacheEnabled(a.getBoolean(attr, true));
488 break;
489 case R.styleable.ViewGroup_layoutAnimation:
490 int id = a.getResourceId(attr, -1);
491 if (id > 0) {
492 setLayoutAnimation(AnimationUtils.loadLayoutAnimation(mContext, id));
493 }
494 break;
495 case R.styleable.ViewGroup_descendantFocusability:
496 setDescendantFocusability(DESCENDANT_FOCUSABILITY_FLAGS[a.getInt(attr, 0)]);
497 break;
Adam Powell2b342f02010-08-18 18:14:13 -0700498 case R.styleable.ViewGroup_splitMotionEvents:
499 setMotionEventSplittingEnabled(a.getBoolean(attr, false));
500 break;
Chet Haase13cc1202010-09-03 15:39:20 -0700501 case R.styleable.ViewGroup_animateLayoutChanges:
502 boolean animateLayoutChanges = a.getBoolean(attr, false);
503 if (animateLayoutChanges) {
504 setLayoutTransition(new LayoutTransition());
505 }
506 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800507 }
508 }
509
510 a.recycle();
511 }
512
513 /**
514 * Gets the descendant focusability of this view group. The descendant
515 * focusability defines the relationship between this view group and its
516 * descendants when looking for a view to take focus in
517 * {@link #requestFocus(int, android.graphics.Rect)}.
518 *
519 * @return one of {@link #FOCUS_BEFORE_DESCENDANTS}, {@link #FOCUS_AFTER_DESCENDANTS},
520 * {@link #FOCUS_BLOCK_DESCENDANTS}.
521 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -0700522 @ViewDebug.ExportedProperty(category = "focus", mapping = {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800523 @ViewDebug.IntToString(from = FOCUS_BEFORE_DESCENDANTS, to = "FOCUS_BEFORE_DESCENDANTS"),
524 @ViewDebug.IntToString(from = FOCUS_AFTER_DESCENDANTS, to = "FOCUS_AFTER_DESCENDANTS"),
525 @ViewDebug.IntToString(from = FOCUS_BLOCK_DESCENDANTS, to = "FOCUS_BLOCK_DESCENDANTS")
526 })
527 public int getDescendantFocusability() {
528 return mGroupFlags & FLAG_MASK_FOCUSABILITY;
529 }
530
531 /**
532 * Set the descendant focusability of this view group. This defines the relationship
533 * between this view group and its descendants when looking for a view to
534 * take focus in {@link #requestFocus(int, android.graphics.Rect)}.
535 *
536 * @param focusability one of {@link #FOCUS_BEFORE_DESCENDANTS}, {@link #FOCUS_AFTER_DESCENDANTS},
537 * {@link #FOCUS_BLOCK_DESCENDANTS}.
538 */
539 public void setDescendantFocusability(int focusability) {
540 switch (focusability) {
541 case FOCUS_BEFORE_DESCENDANTS:
542 case FOCUS_AFTER_DESCENDANTS:
543 case FOCUS_BLOCK_DESCENDANTS:
544 break;
545 default:
546 throw new IllegalArgumentException("must be one of FOCUS_BEFORE_DESCENDANTS, "
547 + "FOCUS_AFTER_DESCENDANTS, FOCUS_BLOCK_DESCENDANTS");
548 }
549 mGroupFlags &= ~FLAG_MASK_FOCUSABILITY;
550 mGroupFlags |= (focusability & FLAG_MASK_FOCUSABILITY);
551 }
552
553 /**
554 * {@inheritDoc}
555 */
556 @Override
557 void handleFocusGainInternal(int direction, Rect previouslyFocusedRect) {
558 if (mFocused != null) {
559 mFocused.unFocus();
560 mFocused = null;
561 }
562 super.handleFocusGainInternal(direction, previouslyFocusedRect);
563 }
564
565 /**
566 * {@inheritDoc}
567 */
568 public void requestChildFocus(View child, View focused) {
569 if (DBG) {
570 System.out.println(this + " requestChildFocus()");
571 }
572 if (getDescendantFocusability() == FOCUS_BLOCK_DESCENDANTS) {
573 return;
574 }
575
576 // Unfocus us, if necessary
577 super.unFocus();
578
579 // We had a previous notion of who had focus. Clear it.
580 if (mFocused != child) {
581 if (mFocused != null) {
582 mFocused.unFocus();
583 }
584
585 mFocused = child;
586 }
587 if (mParent != null) {
588 mParent.requestChildFocus(this, focused);
589 }
590 }
591
592 /**
593 * {@inheritDoc}
594 */
595 public void focusableViewAvailable(View v) {
596 if (mParent != null
597 // shortcut: don't report a new focusable view if we block our descendants from
598 // getting focus
599 && (getDescendantFocusability() != FOCUS_BLOCK_DESCENDANTS)
600 // shortcut: don't report a new focusable view if we already are focused
601 // (and we don't prefer our descendants)
602 //
603 // note: knowing that mFocused is non-null is not a good enough reason
604 // to break the traversal since in that case we'd actually have to find
605 // the focused view and make sure it wasn't FOCUS_AFTER_DESCENDANTS and
Joe Onoratoc6cc0f82011-04-12 11:53:13 -0700606 // an ancestor of v; this will get checked for at ViewAncestor
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800607 && !(isFocused() && getDescendantFocusability() != FOCUS_AFTER_DESCENDANTS)) {
608 mParent.focusableViewAvailable(v);
609 }
610 }
611
612 /**
613 * {@inheritDoc}
614 */
615 public boolean showContextMenuForChild(View originalView) {
616 return mParent != null && mParent.showContextMenuForChild(originalView);
617 }
618
619 /**
Adam Powell6e346362010-07-23 10:18:23 -0700620 * {@inheritDoc}
621 */
622 public ActionMode startActionModeForChild(View originalView, ActionMode.Callback callback) {
623 return mParent != null ? mParent.startActionModeForChild(originalView, callback) : null;
624 }
625
626 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800627 * Find the nearest view in the specified direction that wants to take
628 * focus.
629 *
630 * @param focused The view that currently has focus
631 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and
632 * FOCUS_RIGHT, or 0 for not applicable.
633 */
634 public View focusSearch(View focused, int direction) {
Svetoslav Ganov27e2da72012-07-02 18:12:00 -0700635 if (isRootNamespace()) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800636 // root namespace means we should consider ourselves the top of the
637 // tree for focus searching; otherwise we could be focus searching
638 // into other tabs. see LocalActivityManager and TabHost for more info
639 return FocusFinder.getInstance().findNextFocus(this, focused, direction);
640 } else if (mParent != null) {
641 return mParent.focusSearch(focused, direction);
642 }
643 return null;
644 }
645
646 /**
647 * {@inheritDoc}
648 */
649 public boolean requestChildRectangleOnScreen(View child, Rect rectangle, boolean immediate) {
650 return false;
651 }
652
653 /**
654 * {@inheritDoc}
655 */
Svetoslav Ganov42138042012-03-20 11:51:39 -0700656 @Override
Svetoslav Ganov736c2752011-04-22 18:30:36 -0700657 public boolean requestSendAccessibilityEvent(View child, AccessibilityEvent event) {
Svetoslav Ganov42138042012-03-20 11:51:39 -0700658 ViewParent parent = mParent;
Svetoslav Ganov736c2752011-04-22 18:30:36 -0700659 if (parent == null) {
660 return false;
661 }
662 final boolean propagate = onRequestSendAccessibilityEvent(child, event);
663 if (!propagate) {
664 return false;
665 }
666 return parent.requestSendAccessibilityEvent(this, event);
667 }
668
669 /**
670 * Called when a child has requested sending an {@link AccessibilityEvent} and
671 * gives an opportunity to its parent to augment the event.
Svetoslav Ganov031d9c12011-09-09 16:41:13 -0700672 * <p>
Adam Powell2fcbbd02011-09-28 18:56:43 -0700673 * If an {@link android.view.View.AccessibilityDelegate} has been specified via calling
674 * {@link android.view.View#setAccessibilityDelegate(android.view.View.AccessibilityDelegate)} its
675 * {@link android.view.View.AccessibilityDelegate#onRequestSendAccessibilityEvent(ViewGroup, View, AccessibilityEvent)}
Svetoslav Ganov031d9c12011-09-09 16:41:13 -0700676 * is responsible for handling this call.
677 * </p>
Svetoslav Ganov736c2752011-04-22 18:30:36 -0700678 *
679 * @param child The child which requests sending the event.
680 * @param event The event to be sent.
681 * @return True if the event should be sent.
682 *
683 * @see #requestSendAccessibilityEvent(View, AccessibilityEvent)
684 */
685 public boolean onRequestSendAccessibilityEvent(View child, AccessibilityEvent event) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -0700686 if (mAccessibilityDelegate != null) {
687 return mAccessibilityDelegate.onRequestSendAccessibilityEvent(this, child, event);
688 } else {
689 return onRequestSendAccessibilityEventInternal(child, event);
690 }
691 }
692
693 /**
694 * @see #onRequestSendAccessibilityEvent(View, AccessibilityEvent)
695 *
696 * Note: Called from the default {@link View.AccessibilityDelegate}.
697 */
698 boolean onRequestSendAccessibilityEventInternal(View child, AccessibilityEvent event) {
Svetoslav Ganov736c2752011-04-22 18:30:36 -0700699 return true;
700 }
701
702 /**
Adam Powell539ee872012-02-03 19:00:49 -0800703 * Called when a child view has changed whether or not it is tracking transient state.
704 *
705 * @hide
706 */
707 public void childHasTransientStateChanged(View child, boolean childHasTransientState) {
708 final boolean oldHasTransientState = hasTransientState();
709 if (childHasTransientState) {
710 mChildCountWithTransientState++;
711 } else {
712 mChildCountWithTransientState--;
713 }
714
715 final boolean newHasTransientState = hasTransientState();
716 if (mParent != null && oldHasTransientState != newHasTransientState) {
717 try {
718 mParent.childHasTransientStateChanged(this, newHasTransientState);
719 } catch (AbstractMethodError e) {
720 Log.e(TAG, mParent.getClass().getSimpleName() +
721 " does not fully implement ViewParent", e);
722 }
723 }
724 }
725
726 /**
727 * @hide
728 */
729 @Override
730 public boolean hasTransientState() {
731 return mChildCountWithTransientState > 0 || super.hasTransientState();
732 }
733
734 /**
Svetoslav Ganov736c2752011-04-22 18:30:36 -0700735 * {@inheritDoc}
736 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800737 @Override
738 public boolean dispatchUnhandledMove(View focused, int direction) {
739 return mFocused != null &&
740 mFocused.dispatchUnhandledMove(focused, direction);
741 }
742
743 /**
744 * {@inheritDoc}
745 */
746 public void clearChildFocus(View child) {
747 if (DBG) {
748 System.out.println(this + " clearChildFocus()");
749 }
750
751 mFocused = null;
752 if (mParent != null) {
753 mParent.clearChildFocus(this);
754 }
755 }
756
757 /**
758 * {@inheritDoc}
759 */
760 @Override
761 public void clearFocus() {
Svetoslav Ganovb36a0ac2012-02-14 17:46:47 -0800762 if (DBG) {
763 System.out.println(this + " clearFocus()");
764 }
765 if (mFocused == null) {
766 super.clearFocus();
767 } else {
Svetoslav Ganovb552d892012-06-02 14:35:02 -0700768 View focused = mFocused;
Svetoslav Ganovb36a0ac2012-02-14 17:46:47 -0800769 mFocused = null;
Svetoslav Ganovb552d892012-06-02 14:35:02 -0700770 focused.clearFocus();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800771 }
772 }
773
774 /**
775 * {@inheritDoc}
776 */
777 @Override
778 void unFocus() {
779 if (DBG) {
780 System.out.println(this + " unFocus()");
781 }
Svetoslav Ganovb36a0ac2012-02-14 17:46:47 -0800782 if (mFocused == null) {
783 super.unFocus();
784 } else {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800785 mFocused.unFocus();
Svetoslav Ganovb36a0ac2012-02-14 17:46:47 -0800786 mFocused = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800787 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800788 }
789
790 /**
791 * Returns the focused child of this view, if any. The child may have focus
792 * or contain focus.
793 *
794 * @return the focused child or null.
795 */
796 public View getFocusedChild() {
797 return mFocused;
798 }
799
800 /**
801 * Returns true if this view has or contains focus
802 *
803 * @return true if this view has or contains focus
804 */
805 @Override
806 public boolean hasFocus() {
Dianne Hackborn4702a852012-08-17 15:18:29 -0700807 return (mPrivateFlags & PFLAG_FOCUSED) != 0 || mFocused != null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800808 }
809
810 /*
811 * (non-Javadoc)
812 *
813 * @see android.view.View#findFocus()
814 */
815 @Override
816 public View findFocus() {
817 if (DBG) {
818 System.out.println("Find focus in " + this + ": flags="
819 + isFocused() + ", child=" + mFocused);
820 }
821
822 if (isFocused()) {
823 return this;
824 }
825
826 if (mFocused != null) {
827 return mFocused.findFocus();
828 }
829 return null;
830 }
831
832 /**
833 * {@inheritDoc}
834 */
835 @Override
836 public boolean hasFocusable() {
837 if ((mViewFlags & VISIBILITY_MASK) != VISIBLE) {
838 return false;
839 }
840
841 if (isFocusable()) {
842 return true;
843 }
844
845 final int descendantFocusability = getDescendantFocusability();
846 if (descendantFocusability != FOCUS_BLOCK_DESCENDANTS) {
847 final int count = mChildrenCount;
848 final View[] children = mChildren;
849
850 for (int i = 0; i < count; i++) {
851 final View child = children[i];
852 if (child.hasFocusable()) {
853 return true;
854 }
855 }
856 }
857
858 return false;
859 }
860
861 /**
862 * {@inheritDoc}
863 */
864 @Override
svetoslavganov75986cf2009-05-14 22:28:01 -0700865 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800866 final int focusableCount = views.size();
867
868 final int descendantFocusability = getDescendantFocusability();
869
Svetoslav Ganov27e2da72012-07-02 18:12:00 -0700870 if (descendantFocusability != FOCUS_BLOCK_DESCENDANTS) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800871 final int count = mChildrenCount;
872 final View[] children = mChildren;
873
874 for (int i = 0; i < count; i++) {
875 final View child = children[i];
876 if ((child.mViewFlags & VISIBILITY_MASK) == VISIBLE) {
svetoslavganov75986cf2009-05-14 22:28:01 -0700877 child.addFocusables(views, direction, focusableMode);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800878 }
879 }
880 }
881
882 // we add ourselves (if focusable) in all cases except for when we are
883 // FOCUS_AFTER_DESCENDANTS and there are some descendants focusable. this is
884 // to avoid the focus search finding layouts when a more precise search
885 // among the focusable children would be more interesting.
Svetoslav Ganove5dfa472012-05-08 15:58:32 -0700886 if (descendantFocusability != FOCUS_AFTER_DESCENDANTS
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800887 // No focusable descendants
Svetoslav Ganov27e2da72012-07-02 18:12:00 -0700888 || (focusableCount == views.size())) {
svetoslavganov75986cf2009-05-14 22:28:01 -0700889 super.addFocusables(views, direction, focusableMode);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800890 }
891 }
892
Svetoslav Ganov8643aa02011-04-20 12:12:33 -0700893 @Override
Svetoslav Ganovea515ae2011-09-14 18:15:32 -0700894 public void findViewsWithText(ArrayList<View> outViews, CharSequence text, int flags) {
895 super.findViewsWithText(outViews, text, flags);
Svetoslav Ganov8643aa02011-04-20 12:12:33 -0700896 final int childrenCount = mChildrenCount;
897 final View[] children = mChildren;
898 for (int i = 0; i < childrenCount; i++) {
899 View child = children[i];
Svetoslav Ganovea515ae2011-09-14 18:15:32 -0700900 if ((child.mViewFlags & VISIBILITY_MASK) == VISIBLE
Dianne Hackborn4702a852012-08-17 15:18:29 -0700901 && (child.mPrivateFlags & PFLAG_IS_ROOT_NAMESPACE) == 0) {
Svetoslav Ganovea515ae2011-09-14 18:15:32 -0700902 child.findViewsWithText(outViews, text, flags);
Svetoslav Ganov8643aa02011-04-20 12:12:33 -0700903 }
904 }
905 }
906
Svetoslav Ganov2cdedff2011-10-03 14:18:42 -0700907 @Override
908 View findViewByAccessibilityIdTraversal(int accessibilityId) {
909 View foundView = super.findViewByAccessibilityIdTraversal(accessibilityId);
910 if (foundView != null) {
911 return foundView;
912 }
913 final int childrenCount = mChildrenCount;
914 final View[] children = mChildren;
915 for (int i = 0; i < childrenCount; i++) {
916 View child = children[i];
917 foundView = child.findViewByAccessibilityIdTraversal(accessibilityId);
918 if (foundView != null) {
919 return foundView;
920 }
921 }
922 return null;
923 }
924
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800925 /**
926 * {@inheritDoc}
927 */
928 @Override
929 public void dispatchWindowFocusChanged(boolean hasFocus) {
930 super.dispatchWindowFocusChanged(hasFocus);
931 final int count = mChildrenCount;
932 final View[] children = mChildren;
933 for (int i = 0; i < count; i++) {
934 children[i].dispatchWindowFocusChanged(hasFocus);
935 }
936 }
937
938 /**
939 * {@inheritDoc}
940 */
941 @Override
942 public void addTouchables(ArrayList<View> views) {
943 super.addTouchables(views);
944
945 final int count = mChildrenCount;
946 final View[] children = mChildren;
947
948 for (int i = 0; i < count; i++) {
949 final View child = children[i];
950 if ((child.mViewFlags & VISIBILITY_MASK) == VISIBLE) {
951 child.addTouchables(views);
952 }
953 }
954 }
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -0700955
956 /**
957 * @hide
958 */
959 @Override
960 public void makeOptionalFitsSystemWindows() {
961 super.makeOptionalFitsSystemWindows();
962 final int count = mChildrenCount;
963 final View[] children = mChildren;
964 for (int i = 0; i < count; i++) {
965 children[i].makeOptionalFitsSystemWindows();
966 }
967 }
968
Romain Guy43c9cdf2010-01-27 13:53:55 -0800969 /**
970 * {@inheritDoc}
971 */
972 @Override
973 public void dispatchDisplayHint(int hint) {
974 super.dispatchDisplayHint(hint);
975 final int count = mChildrenCount;
976 final View[] children = mChildren;
977 for (int i = 0; i < count; i++) {
978 children[i].dispatchDisplayHint(hint);
979 }
980 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800981
982 /**
Chet Haase0d299362012-01-26 10:51:48 -0800983 * Called when a view's visibility has changed. Notify the parent to take any appropriate
984 * action.
985 *
986 * @param child The view whose visibility has changed
987 * @param oldVisibility The previous visibility value (GONE, INVISIBLE, or VISIBLE).
988 * @param newVisibility The new visibility value (GONE, INVISIBLE, or VISIBLE).
Chet Haase5e25c2c2010-09-16 11:15:56 -0700989 * @hide
Chet Haase5e25c2c2010-09-16 11:15:56 -0700990 */
Chet Haase0d299362012-01-26 10:51:48 -0800991 protected void onChildVisibilityChanged(View child, int oldVisibility, int newVisibility) {
Chet Haase5e25c2c2010-09-16 11:15:56 -0700992 if (mTransition != null) {
Chet Haase0d299362012-01-26 10:51:48 -0800993 if (newVisibility == VISIBLE) {
994 mTransition.showChild(this, child, oldVisibility);
Chet Haase5e25c2c2010-09-16 11:15:56 -0700995 } else {
Chet Haase0d299362012-01-26 10:51:48 -0800996 mTransition.hideChild(this, child, newVisibility);
Chet Haase5e25c2c2010-09-16 11:15:56 -0700997 if (mTransitioningViews != null && mTransitioningViews.contains(child)) {
Chet Haaseddbb3462012-06-19 13:54:29 -0700998 // Only track this on disappearing views - appearing views are already visible
999 // and don't need special handling during drawChild()
1000 if (mVisibilityChangingChildren == null) {
1001 mVisibilityChangingChildren = new ArrayList<View>();
1002 }
1003 mVisibilityChangingChildren.add(child);
Chet Haase5e25c2c2010-09-16 11:15:56 -07001004 addDisappearingView(child);
1005 }
1006 }
1007 }
Christopher Tate86cab1b2011-01-13 20:28:55 -08001008
1009 // in all cases, for drags
1010 if (mCurrentDrag != null) {
Chet Haase0d299362012-01-26 10:51:48 -08001011 if (newVisibility == VISIBLE) {
Christopher Tate86cab1b2011-01-13 20:28:55 -08001012 notifyChildOfDrag(child);
1013 }
1014 }
Chet Haase5e25c2c2010-09-16 11:15:56 -07001015 }
1016
1017 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001018 * {@inheritDoc}
1019 */
1020 @Override
Adam Powell326d8082009-12-09 15:10:07 -08001021 protected void dispatchVisibilityChanged(View changedView, int visibility) {
1022 super.dispatchVisibilityChanged(changedView, visibility);
1023 final int count = mChildrenCount;
1024 final View[] children = mChildren;
1025 for (int i = 0; i < count; i++) {
1026 children[i].dispatchVisibilityChanged(changedView, visibility);
1027 }
1028 }
1029
1030 /**
1031 * {@inheritDoc}
1032 */
1033 @Override
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001034 public void dispatchWindowVisibilityChanged(int visibility) {
1035 super.dispatchWindowVisibilityChanged(visibility);
1036 final int count = mChildrenCount;
1037 final View[] children = mChildren;
1038 for (int i = 0; i < count; i++) {
1039 children[i].dispatchWindowVisibilityChanged(visibility);
1040 }
1041 }
1042
1043 /**
1044 * {@inheritDoc}
1045 */
Dianne Hackborne36d6e22010-02-17 19:46:25 -08001046 @Override
1047 public void dispatchConfigurationChanged(Configuration newConfig) {
1048 super.dispatchConfigurationChanged(newConfig);
1049 final int count = mChildrenCount;
1050 final View[] children = mChildren;
1051 for (int i = 0; i < count; i++) {
1052 children[i].dispatchConfigurationChanged(newConfig);
1053 }
1054 }
1055
1056 /**
1057 * {@inheritDoc}
1058 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001059 public void recomputeViewAttributes(View child) {
Joe Onorato664644d2011-01-23 17:53:23 -08001060 if (mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
1061 ViewParent parent = mParent;
1062 if (parent != null) parent.recomputeViewAttributes(this);
1063 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001064 }
Romain Guy8506ab42009-06-11 17:35:47 -07001065
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001066 @Override
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07001067 void dispatchCollectViewAttributes(AttachInfo attachInfo, int visibility) {
1068 if ((visibility & VISIBILITY_MASK) == VISIBLE) {
1069 super.dispatchCollectViewAttributes(attachInfo, visibility);
1070 final int count = mChildrenCount;
1071 final View[] children = mChildren;
1072 for (int i = 0; i < count; i++) {
1073 final View child = children[i];
1074 child.dispatchCollectViewAttributes(attachInfo,
1075 visibility | (child.mViewFlags&VISIBILITY_MASK));
1076 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001077 }
1078 }
1079
1080 /**
1081 * {@inheritDoc}
1082 */
1083 public void bringChildToFront(View child) {
1084 int index = indexOfChild(child);
1085 if (index >= 0) {
1086 removeFromArray(index);
1087 addInArray(child, mChildrenCount);
1088 child.mParent = this;
1089 }
1090 }
1091
1092 /**
1093 * {@inheritDoc}
Christopher Tatea53146c2010-09-07 11:57:52 -07001094 */
Steve Block8a7259b2012-03-01 11:24:41 +00001095 // TODO: Write real docs
Christopher Tatea53146c2010-09-07 11:57:52 -07001096 @Override
1097 public boolean dispatchDragEvent(DragEvent event) {
1098 boolean retval = false;
1099 final float tx = event.mX;
1100 final float ty = event.mY;
1101
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07001102 ViewRootImpl root = getViewRootImpl();
Christopher Tatea53146c2010-09-07 11:57:52 -07001103
1104 // Dispatch down the view hierarchy
1105 switch (event.mAction) {
1106 case DragEvent.ACTION_DRAG_STARTED: {
1107 // clear state to recalculate which views we drag over
Chris Tate9d1ab882010-11-02 15:55:39 -07001108 mCurrentDragView = null;
Christopher Tatea53146c2010-09-07 11:57:52 -07001109
Christopher Tate86cab1b2011-01-13 20:28:55 -08001110 // Set up our tracking of drag-started notifications
1111 mCurrentDrag = DragEvent.obtain(event);
1112 if (mDragNotifiedChildren == null) {
1113 mDragNotifiedChildren = new HashSet<View>();
1114 } else {
1115 mDragNotifiedChildren.clear();
1116 }
1117
Christopher Tatea53146c2010-09-07 11:57:52 -07001118 // Now dispatch down to our children, caching the responses
1119 mChildAcceptsDrag = false;
1120 final int count = mChildrenCount;
1121 final View[] children = mChildren;
1122 for (int i = 0; i < count; i++) {
Christopher Tate2c095f32010-10-04 14:13:40 -07001123 final View child = children[i];
Christopher Tate3d4bf172011-03-28 16:16:46 -07001124 child.mPrivateFlags2 &= ~View.DRAG_MASK;
Christopher Tate2c095f32010-10-04 14:13:40 -07001125 if (child.getVisibility() == VISIBLE) {
Christopher Tate86cab1b2011-01-13 20:28:55 -08001126 final boolean handled = notifyChildOfDrag(children[i]);
Christopher Tate2c095f32010-10-04 14:13:40 -07001127 if (handled) {
1128 mChildAcceptsDrag = true;
1129 }
Christopher Tatea53146c2010-09-07 11:57:52 -07001130 }
1131 }
1132
1133 // Return HANDLED if one of our children can accept the drag
1134 if (mChildAcceptsDrag) {
1135 retval = true;
1136 }
1137 } break;
1138
1139 case DragEvent.ACTION_DRAG_ENDED: {
Christopher Tate86cab1b2011-01-13 20:28:55 -08001140 // Release the bookkeeping now that the drag lifecycle has ended
Christopher Tate1fc014f2011-01-19 12:56:26 -08001141 if (mDragNotifiedChildren != null) {
1142 for (View child : mDragNotifiedChildren) {
1143 // If a child was notified about an ongoing drag, it's told that it's over
1144 child.dispatchDragEvent(event);
Christopher Tate3d4bf172011-03-28 16:16:46 -07001145 child.mPrivateFlags2 &= ~View.DRAG_MASK;
1146 child.refreshDrawableState();
Christopher Tate1fc014f2011-01-19 12:56:26 -08001147 }
1148
1149 mDragNotifiedChildren.clear();
1150 mCurrentDrag.recycle();
1151 mCurrentDrag = null;
1152 }
Christopher Tate86cab1b2011-01-13 20:28:55 -08001153
Christopher Tatea53146c2010-09-07 11:57:52 -07001154 // We consider drag-ended to have been handled if one of our children
1155 // had offered to handle the drag.
1156 if (mChildAcceptsDrag) {
1157 retval = true;
1158 }
1159 } break;
1160
1161 case DragEvent.ACTION_DRAG_LOCATION: {
1162 // Find the [possibly new] drag target
1163 final View target = findFrontmostDroppableChildAt(event.mX, event.mY, mLocalPoint);
1164
1165 // If we've changed apparent drag target, tell the view root which view
Chris Tate9d1ab882010-11-02 15:55:39 -07001166 // we're over now [for purposes of the eventual drag-recipient-changed
1167 // notifications to the framework] and tell the new target that the drag
1168 // has entered its bounds. The root will see setDragFocus() calls all
1169 // the way down to the final leaf view that is handling the LOCATION event
1170 // before reporting the new potential recipient to the framework.
Christopher Tatea53146c2010-09-07 11:57:52 -07001171 if (mCurrentDragView != target) {
Chris Tate9d1ab882010-11-02 15:55:39 -07001172 root.setDragFocus(target);
1173
1174 final int action = event.mAction;
1175 // If we've dragged off of a child view, send it the EXITED message
1176 if (mCurrentDragView != null) {
Christopher Tate3d4bf172011-03-28 16:16:46 -07001177 final View view = mCurrentDragView;
Chris Tate9d1ab882010-11-02 15:55:39 -07001178 event.mAction = DragEvent.ACTION_DRAG_EXITED;
Christopher Tate3d4bf172011-03-28 16:16:46 -07001179 view.dispatchDragEvent(event);
Dianne Hackborn4702a852012-08-17 15:18:29 -07001180 view.mPrivateFlags2 &= ~View.PFLAG2_DRAG_HOVERED;
Christopher Tate3d4bf172011-03-28 16:16:46 -07001181 view.refreshDrawableState();
Chris Tate9d1ab882010-11-02 15:55:39 -07001182 }
Christopher Tatea53146c2010-09-07 11:57:52 -07001183 mCurrentDragView = target;
Chris Tate9d1ab882010-11-02 15:55:39 -07001184
1185 // If we've dragged over a new child view, send it the ENTERED message
1186 if (target != null) {
1187 event.mAction = DragEvent.ACTION_DRAG_ENTERED;
1188 target.dispatchDragEvent(event);
Dianne Hackborn4702a852012-08-17 15:18:29 -07001189 target.mPrivateFlags2 |= View.PFLAG2_DRAG_HOVERED;
Christopher Tate3d4bf172011-03-28 16:16:46 -07001190 target.refreshDrawableState();
Chris Tate9d1ab882010-11-02 15:55:39 -07001191 }
1192 event.mAction = action; // restore the event's original state
Christopher Tatea53146c2010-09-07 11:57:52 -07001193 }
Christopher Tate2c095f32010-10-04 14:13:40 -07001194
Christopher Tatea53146c2010-09-07 11:57:52 -07001195 // Dispatch the actual drag location notice, localized into its coordinates
1196 if (target != null) {
1197 event.mX = mLocalPoint.x;
1198 event.mY = mLocalPoint.y;
1199
1200 retval = target.dispatchDragEvent(event);
1201
1202 event.mX = tx;
1203 event.mY = ty;
1204 }
1205 } break;
1206
Chris Tate9d1ab882010-11-02 15:55:39 -07001207 /* Entered / exited dispatch
1208 *
1209 * DRAG_ENTERED is not dispatched downwards from ViewGroup. The reason for this is
1210 * that we're about to get the corresponding LOCATION event, which we will use to
1211 * determine which of our children is the new target; at that point we will
1212 * push a DRAG_ENTERED down to the new target child [which may itself be a ViewGroup].
1213 *
1214 * DRAG_EXITED *is* dispatched all the way down immediately: once we know the
1215 * drag has left this ViewGroup, we know by definition that every contained subview
1216 * is also no longer under the drag point.
1217 */
1218
1219 case DragEvent.ACTION_DRAG_EXITED: {
1220 if (mCurrentDragView != null) {
Christopher Tate3d4bf172011-03-28 16:16:46 -07001221 final View view = mCurrentDragView;
1222 view.dispatchDragEvent(event);
Dianne Hackborn4702a852012-08-17 15:18:29 -07001223 view.mPrivateFlags2 &= ~View.PFLAG2_DRAG_HOVERED;
Christopher Tate3d4bf172011-03-28 16:16:46 -07001224 view.refreshDrawableState();
1225
Chris Tate9d1ab882010-11-02 15:55:39 -07001226 mCurrentDragView = null;
1227 }
1228 } break;
1229
Christopher Tatea53146c2010-09-07 11:57:52 -07001230 case DragEvent.ACTION_DROP: {
Christopher Tate2c095f32010-10-04 14:13:40 -07001231 if (ViewDebug.DEBUG_DRAG) Log.d(View.VIEW_LOG_TAG, "Drop event: " + event);
Christopher Tatea53146c2010-09-07 11:57:52 -07001232 View target = findFrontmostDroppableChildAt(event.mX, event.mY, mLocalPoint);
1233 if (target != null) {
Christopher Tate5ada6cb2010-10-05 14:15:29 -07001234 if (ViewDebug.DEBUG_DRAG) Log.d(View.VIEW_LOG_TAG, " dispatch drop to " + target);
Christopher Tatea53146c2010-09-07 11:57:52 -07001235 event.mX = mLocalPoint.x;
1236 event.mY = mLocalPoint.y;
1237 retval = target.dispatchDragEvent(event);
1238 event.mX = tx;
1239 event.mY = ty;
Christopher Tate5ada6cb2010-10-05 14:15:29 -07001240 } else {
1241 if (ViewDebug.DEBUG_DRAG) {
1242 Log.d(View.VIEW_LOG_TAG, " not dropped on an accepting view");
1243 }
Christopher Tatea53146c2010-09-07 11:57:52 -07001244 }
1245 } break;
1246 }
1247
1248 // If none of our children could handle the event, try here
1249 if (!retval) {
Chris Tate32affef2010-10-18 15:29:21 -07001250 // Call up to the View implementation that dispatches to installed listeners
1251 retval = super.dispatchDragEvent(event);
Christopher Tatea53146c2010-09-07 11:57:52 -07001252 }
1253 return retval;
1254 }
1255
1256 // Find the frontmost child view that lies under the given point, and calculate
1257 // the position within its own local coordinate system.
1258 View findFrontmostDroppableChildAt(float x, float y, PointF outLocalPoint) {
Christopher Tatea53146c2010-09-07 11:57:52 -07001259 final int count = mChildrenCount;
1260 final View[] children = mChildren;
1261 for (int i = count - 1; i >= 0; i--) {
1262 final View child = children[i];
Christopher Tate3d4bf172011-03-28 16:16:46 -07001263 if (!child.canAcceptDrag()) {
Christopher Tatea53146c2010-09-07 11:57:52 -07001264 continue;
1265 }
1266
Christopher Tate2c095f32010-10-04 14:13:40 -07001267 if (isTransformedTouchPointInView(x, y, child, outLocalPoint)) {
Christopher Tatea53146c2010-09-07 11:57:52 -07001268 return child;
1269 }
1270 }
1271 return null;
1272 }
1273
Christopher Tate86cab1b2011-01-13 20:28:55 -08001274 boolean notifyChildOfDrag(View child) {
1275 if (ViewDebug.DEBUG_DRAG) {
1276 Log.d(View.VIEW_LOG_TAG, "Sending drag-started to view: " + child);
1277 }
1278
Christopher Tate3d4bf172011-03-28 16:16:46 -07001279 boolean canAccept = false;
Christopher Tate86cab1b2011-01-13 20:28:55 -08001280 if (! mDragNotifiedChildren.contains(child)) {
1281 mDragNotifiedChildren.add(child);
Christopher Tate3d4bf172011-03-28 16:16:46 -07001282 canAccept = child.dispatchDragEvent(mCurrentDrag);
1283 if (canAccept && !child.canAcceptDrag()) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07001284 child.mPrivateFlags2 |= View.PFLAG2_DRAG_CAN_ACCEPT;
Christopher Tate3d4bf172011-03-28 16:16:46 -07001285 child.refreshDrawableState();
1286 }
Christopher Tate86cab1b2011-01-13 20:28:55 -08001287 }
Christopher Tate3d4bf172011-03-28 16:16:46 -07001288 return canAccept;
Christopher Tate86cab1b2011-01-13 20:28:55 -08001289 }
1290
Joe Onorato664644d2011-01-23 17:53:23 -08001291 @Override
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07001292 public void dispatchWindowSystemUiVisiblityChanged(int visible) {
1293 super.dispatchWindowSystemUiVisiblityChanged(visible);
1294
1295 final int count = mChildrenCount;
1296 final View[] children = mChildren;
1297 for (int i=0; i <count; i++) {
1298 final View child = children[i];
1299 child.dispatchWindowSystemUiVisiblityChanged(visible);
1300 }
1301 }
1302
1303 @Override
Joe Onorato664644d2011-01-23 17:53:23 -08001304 public void dispatchSystemUiVisibilityChanged(int visible) {
1305 super.dispatchSystemUiVisibilityChanged(visible);
1306
1307 final int count = mChildrenCount;
1308 final View[] children = mChildren;
1309 for (int i=0; i <count; i++) {
1310 final View child = children[i];
1311 child.dispatchSystemUiVisibilityChanged(visible);
1312 }
1313 }
1314
Dianne Hackborn9a230e02011-10-06 11:51:27 -07001315 @Override
Dianne Hackborncf675782012-05-10 15:07:24 -07001316 boolean updateLocalSystemUiVisibility(int localValue, int localChanges) {
1317 boolean changed = super.updateLocalSystemUiVisibility(localValue, localChanges);
Dianne Hackborn9a230e02011-10-06 11:51:27 -07001318
1319 final int count = mChildrenCount;
1320 final View[] children = mChildren;
1321 for (int i=0; i <count; i++) {
1322 final View child = children[i];
Dianne Hackborncf675782012-05-10 15:07:24 -07001323 changed |= child.updateLocalSystemUiVisibility(localValue, localChanges);
Dianne Hackborn9a230e02011-10-06 11:51:27 -07001324 }
Dianne Hackborncf675782012-05-10 15:07:24 -07001325 return changed;
Dianne Hackborn9a230e02011-10-06 11:51:27 -07001326 }
1327
Christopher Tatea53146c2010-09-07 11:57:52 -07001328 /**
1329 * {@inheritDoc}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001330 */
1331 @Override
1332 public boolean dispatchKeyEventPreIme(KeyEvent event) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07001333 if ((mPrivateFlags & (PFLAG_FOCUSED | PFLAG_HAS_BOUNDS))
1334 == (PFLAG_FOCUSED | PFLAG_HAS_BOUNDS)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001335 return super.dispatchKeyEventPreIme(event);
Dianne Hackborn4702a852012-08-17 15:18:29 -07001336 } else if (mFocused != null && (mFocused.mPrivateFlags & PFLAG_HAS_BOUNDS)
1337 == PFLAG_HAS_BOUNDS) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001338 return mFocused.dispatchKeyEventPreIme(event);
1339 }
1340 return false;
1341 }
1342
1343 /**
1344 * {@inheritDoc}
1345 */
1346 @Override
1347 public boolean dispatchKeyEvent(KeyEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08001348 if (mInputEventConsistencyVerifier != null) {
1349 mInputEventConsistencyVerifier.onKeyEvent(event, 1);
1350 }
1351
Dianne Hackborn4702a852012-08-17 15:18:29 -07001352 if ((mPrivateFlags & (PFLAG_FOCUSED | PFLAG_HAS_BOUNDS))
1353 == (PFLAG_FOCUSED | PFLAG_HAS_BOUNDS)) {
Jeff Brownbbdc50b2011-04-19 23:46:52 -07001354 if (super.dispatchKeyEvent(event)) {
1355 return true;
1356 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07001357 } else if (mFocused != null && (mFocused.mPrivateFlags & PFLAG_HAS_BOUNDS)
1358 == PFLAG_HAS_BOUNDS) {
Jeff Brownbbdc50b2011-04-19 23:46:52 -07001359 if (mFocused.dispatchKeyEvent(event)) {
1360 return true;
1361 }
1362 }
1363
1364 if (mInputEventConsistencyVerifier != null) {
1365 mInputEventConsistencyVerifier.onUnhandledEvent(event, 1);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001366 }
1367 return false;
1368 }
1369
1370 /**
1371 * {@inheritDoc}
1372 */
1373 @Override
1374 public boolean dispatchKeyShortcutEvent(KeyEvent event) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07001375 if ((mPrivateFlags & (PFLAG_FOCUSED | PFLAG_HAS_BOUNDS))
1376 == (PFLAG_FOCUSED | PFLAG_HAS_BOUNDS)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001377 return super.dispatchKeyShortcutEvent(event);
Dianne Hackborn4702a852012-08-17 15:18:29 -07001378 } else if (mFocused != null && (mFocused.mPrivateFlags & PFLAG_HAS_BOUNDS)
1379 == PFLAG_HAS_BOUNDS) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001380 return mFocused.dispatchKeyShortcutEvent(event);
1381 }
1382 return false;
1383 }
1384
1385 /**
1386 * {@inheritDoc}
1387 */
1388 @Override
1389 public boolean dispatchTrackballEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08001390 if (mInputEventConsistencyVerifier != null) {
1391 mInputEventConsistencyVerifier.onTrackballEvent(event, 1);
1392 }
1393
Dianne Hackborn4702a852012-08-17 15:18:29 -07001394 if ((mPrivateFlags & (PFLAG_FOCUSED | PFLAG_HAS_BOUNDS))
1395 == (PFLAG_FOCUSED | PFLAG_HAS_BOUNDS)) {
Jeff Brownbbdc50b2011-04-19 23:46:52 -07001396 if (super.dispatchTrackballEvent(event)) {
1397 return true;
1398 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07001399 } else if (mFocused != null && (mFocused.mPrivateFlags & PFLAG_HAS_BOUNDS)
1400 == PFLAG_HAS_BOUNDS) {
Jeff Brownbbdc50b2011-04-19 23:46:52 -07001401 if (mFocused.dispatchTrackballEvent(event)) {
1402 return true;
1403 }
1404 }
1405
1406 if (mInputEventConsistencyVerifier != null) {
1407 mInputEventConsistencyVerifier.onUnhandledEvent(event, 1);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001408 }
1409 return false;
1410 }
1411
Jeff Brown10b62902011-06-20 16:40:37 -07001412 /**
1413 * {@inheritDoc}
1414 */
Romain Guya9489272011-06-22 20:58:11 -07001415 @SuppressWarnings({"ConstantConditions"})
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001416 @Override
Jeff Browna032cc02011-03-07 16:56:21 -08001417 protected boolean dispatchHoverEvent(MotionEvent event) {
Jeff Browna032cc02011-03-07 16:56:21 -08001418 final int action = event.getAction();
Jeff Browna032cc02011-03-07 16:56:21 -08001419
Jeff Brown10b62902011-06-20 16:40:37 -07001420 // First check whether the view group wants to intercept the hover event.
1421 final boolean interceptHover = onInterceptHoverEvent(event);
1422 event.setAction(action); // restore action in case it was changed
1423
Jeff Brown87b7f802011-06-21 18:35:45 -07001424 MotionEvent eventNoHistory = event;
1425 boolean handled = false;
1426
1427 // Send events to the hovered children and build a new list of hover targets until
1428 // one is found that handles the event.
1429 HoverTarget firstOldHoverTarget = mFirstHoverTarget;
1430 mFirstHoverTarget = null;
Jeff Brown10b62902011-06-20 16:40:37 -07001431 if (!interceptHover && action != MotionEvent.ACTION_HOVER_EXIT) {
Jeff Browna032cc02011-03-07 16:56:21 -08001432 final float x = event.getX();
1433 final float y = event.getY();
Jeff Brown33bbfd22011-02-24 20:55:35 -08001434 final int childrenCount = mChildrenCount;
1435 if (childrenCount != 0) {
1436 final View[] children = mChildren;
Jeff Brown87b7f802011-06-21 18:35:45 -07001437 HoverTarget lastHoverTarget = null;
Jeff Brown33bbfd22011-02-24 20:55:35 -08001438 for (int i = childrenCount - 1; i >= 0; i--) {
1439 final View child = children[i];
Jeff Brown87b7f802011-06-21 18:35:45 -07001440 if (!canViewReceivePointerEvents(child)
1441 || !isTransformedTouchPointInView(x, y, child, null)) {
1442 continue;
1443 }
1444
1445 // Obtain a hover target for this child. Dequeue it from the
1446 // old hover target list if the child was previously hovered.
1447 HoverTarget hoverTarget = firstOldHoverTarget;
1448 final boolean wasHovered;
1449 for (HoverTarget predecessor = null; ;) {
1450 if (hoverTarget == null) {
1451 hoverTarget = HoverTarget.obtain(child);
1452 wasHovered = false;
1453 break;
1454 }
1455
1456 if (hoverTarget.child == child) {
1457 if (predecessor != null) {
1458 predecessor.next = hoverTarget.next;
1459 } else {
1460 firstOldHoverTarget = hoverTarget.next;
1461 }
1462 hoverTarget.next = null;
1463 wasHovered = true;
1464 break;
1465 }
1466
1467 predecessor = hoverTarget;
1468 hoverTarget = hoverTarget.next;
1469 }
1470
1471 // Enqueue the hover target onto the new hover target list.
1472 if (lastHoverTarget != null) {
1473 lastHoverTarget.next = hoverTarget;
1474 } else {
1475 lastHoverTarget = hoverTarget;
1476 mFirstHoverTarget = hoverTarget;
1477 }
1478
1479 // Dispatch the event to the child.
1480 if (action == MotionEvent.ACTION_HOVER_ENTER) {
1481 if (!wasHovered) {
1482 // Send the enter as is.
1483 handled |= dispatchTransformedGenericPointerEvent(
1484 event, child); // enter
1485 }
1486 } else if (action == MotionEvent.ACTION_HOVER_MOVE) {
1487 if (!wasHovered) {
1488 // Synthesize an enter from a move.
1489 eventNoHistory = obtainMotionEventNoHistoryOrSelf(eventNoHistory);
1490 eventNoHistory.setAction(MotionEvent.ACTION_HOVER_ENTER);
1491 handled |= dispatchTransformedGenericPointerEvent(
1492 eventNoHistory, child); // enter
1493 eventNoHistory.setAction(action);
1494
1495 handled |= dispatchTransformedGenericPointerEvent(
1496 eventNoHistory, child); // move
1497 } else {
1498 // Send the move as is.
1499 handled |= dispatchTransformedGenericPointerEvent(event, child);
1500 }
1501 }
1502 if (handled) {
Jeff Brown10b62902011-06-20 16:40:37 -07001503 break;
Jeff Brown33bbfd22011-02-24 20:55:35 -08001504 }
Jeff Brown10b62902011-06-20 16:40:37 -07001505 }
1506 }
1507 }
Jeff Brown33bbfd22011-02-24 20:55:35 -08001508
Jeff Brown87b7f802011-06-21 18:35:45 -07001509 // Send exit events to all previously hovered children that are no longer hovered.
1510 while (firstOldHoverTarget != null) {
1511 final View child = firstOldHoverTarget.child;
Jeff Brown10b62902011-06-20 16:40:37 -07001512
Jeff Brown87b7f802011-06-21 18:35:45 -07001513 // Exit the old hovered child.
1514 if (action == MotionEvent.ACTION_HOVER_EXIT) {
1515 // Send the exit as is.
1516 handled |= dispatchTransformedGenericPointerEvent(
1517 event, child); // exit
1518 } else {
1519 // Synthesize an exit from a move or enter.
1520 // Ignore the result because hover focus has moved to a different view.
1521 if (action == MotionEvent.ACTION_HOVER_MOVE) {
Jeff Brown10b62902011-06-20 16:40:37 -07001522 dispatchTransformedGenericPointerEvent(
Jeff Brown87b7f802011-06-21 18:35:45 -07001523 event, child); // move
Jeff Brown10b62902011-06-20 16:40:37 -07001524 }
Jeff Brown87b7f802011-06-21 18:35:45 -07001525 eventNoHistory = obtainMotionEventNoHistoryOrSelf(eventNoHistory);
1526 eventNoHistory.setAction(MotionEvent.ACTION_HOVER_EXIT);
1527 dispatchTransformedGenericPointerEvent(
1528 eventNoHistory, child); // exit
1529 eventNoHistory.setAction(action);
Jeff Brown10b62902011-06-20 16:40:37 -07001530 }
1531
Jeff Brown87b7f802011-06-21 18:35:45 -07001532 final HoverTarget nextOldHoverTarget = firstOldHoverTarget.next;
1533 firstOldHoverTarget.recycle();
1534 firstOldHoverTarget = nextOldHoverTarget;
Jeff Brown10b62902011-06-20 16:40:37 -07001535 }
1536
Jeff Brown87b7f802011-06-21 18:35:45 -07001537 // Send events to the view group itself if no children have handled it.
Jeff Brown10b62902011-06-20 16:40:37 -07001538 boolean newHoveredSelf = !handled;
1539 if (newHoveredSelf == mHoveredSelf) {
1540 if (newHoveredSelf) {
1541 // Send event to the view group as before.
1542 handled |= super.dispatchHoverEvent(event);
1543 }
1544 } else {
1545 if (mHoveredSelf) {
1546 // Exit the view group.
1547 if (action == MotionEvent.ACTION_HOVER_EXIT) {
1548 // Send the exit as is.
1549 handled |= super.dispatchHoverEvent(event); // exit
1550 } else {
1551 // Synthesize an exit from a move or enter.
1552 // Ignore the result because hover focus is moving to a different view.
1553 if (action == MotionEvent.ACTION_HOVER_MOVE) {
1554 super.dispatchHoverEvent(event); // move
1555 }
1556 eventNoHistory = obtainMotionEventNoHistoryOrSelf(eventNoHistory);
1557 eventNoHistory.setAction(MotionEvent.ACTION_HOVER_EXIT);
1558 super.dispatchHoverEvent(eventNoHistory); // exit
1559 eventNoHistory.setAction(action);
1560 }
1561 mHoveredSelf = false;
1562 }
1563
1564 if (newHoveredSelf) {
1565 // Enter the view group.
1566 if (action == MotionEvent.ACTION_HOVER_ENTER) {
1567 // Send the enter as is.
1568 handled |= super.dispatchHoverEvent(event); // enter
1569 mHoveredSelf = true;
1570 } else if (action == MotionEvent.ACTION_HOVER_MOVE) {
1571 // Synthesize an enter from a move.
1572 eventNoHistory = obtainMotionEventNoHistoryOrSelf(eventNoHistory);
1573 eventNoHistory.setAction(MotionEvent.ACTION_HOVER_ENTER);
1574 handled |= super.dispatchHoverEvent(eventNoHistory); // enter
1575 eventNoHistory.setAction(action);
1576
1577 handled |= super.dispatchHoverEvent(eventNoHistory); // move
1578 mHoveredSelf = true;
Jeff Brown33bbfd22011-02-24 20:55:35 -08001579 }
1580 }
Jeff Brown33bbfd22011-02-24 20:55:35 -08001581 }
1582
Jeff Browna032cc02011-03-07 16:56:21 -08001583 // Recycle the copy of the event that we made.
1584 if (eventNoHistory != event) {
1585 eventNoHistory.recycle();
1586 }
1587
Jeff Browna032cc02011-03-07 16:56:21 -08001588 // Done.
1589 return handled;
1590 }
1591
Jeff Brown59a422e2012-04-19 15:19:19 -07001592 private void exitHoverTargets() {
1593 if (mHoveredSelf || mFirstHoverTarget != null) {
1594 final long now = SystemClock.uptimeMillis();
1595 MotionEvent event = MotionEvent.obtain(now, now,
1596 MotionEvent.ACTION_HOVER_EXIT, 0.0f, 0.0f, 0);
1597 event.setSource(InputDevice.SOURCE_TOUCHSCREEN);
1598 dispatchHoverEvent(event);
1599 event.recycle();
1600 }
1601 }
1602
1603 private void cancelHoverTarget(View view) {
1604 HoverTarget predecessor = null;
1605 HoverTarget target = mFirstHoverTarget;
1606 while (target != null) {
1607 final HoverTarget next = target.next;
1608 if (target.child == view) {
1609 if (predecessor == null) {
1610 mFirstHoverTarget = next;
1611 } else {
1612 predecessor.next = next;
1613 }
1614 target.recycle();
1615
1616 final long now = SystemClock.uptimeMillis();
1617 MotionEvent event = MotionEvent.obtain(now, now,
1618 MotionEvent.ACTION_HOVER_EXIT, 0.0f, 0.0f, 0);
1619 event.setSource(InputDevice.SOURCE_TOUCHSCREEN);
1620 view.dispatchHoverEvent(event);
1621 event.recycle();
1622 return;
1623 }
1624 predecessor = target;
1625 target = next;
1626 }
1627 }
1628
Jeff Brown87b7f802011-06-21 18:35:45 -07001629 /** @hide */
1630 @Override
1631 protected boolean hasHoveredChild() {
1632 return mFirstHoverTarget != null;
1633 }
1634
Svetoslav Ganov42138042012-03-20 11:51:39 -07001635 @Override
1636 public void addChildrenForAccessibility(ArrayList<View> childrenForAccessibility) {
Svetoslav Ganov76f287e2012-04-23 11:02:36 -07001637 ChildListForAccessibility children = ChildListForAccessibility.obtain(this, true);
1638 try {
1639 final int childrenCount = children.getChildCount();
1640 for (int i = 0; i < childrenCount; i++) {
1641 View child = children.getChildAt(i);
Svetoslav Ganovc406be92012-05-11 16:12:32 -07001642 if ((child.mViewFlags & VISIBILITY_MASK) == VISIBLE) {
Svetoslav Ganov76f287e2012-04-23 11:02:36 -07001643 if (child.includeForAccessibility()) {
1644 childrenForAccessibility.add(child);
1645 } else {
1646 child.addChildrenForAccessibility(childrenForAccessibility);
1647 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07001648 }
1649 }
Svetoslav Ganov76f287e2012-04-23 11:02:36 -07001650 } finally {
1651 children.recycle();
Svetoslav Ganov42138042012-03-20 11:51:39 -07001652 }
1653 }
1654
1655 /**
1656 * @hide
1657 */
1658 @Override
1659 public void childAccessibilityStateChanged(View child) {
1660 if (mParent != null) {
1661 mParent.childAccessibilityStateChanged(child);
1662 }
1663 }
1664
Jeff Brown10b62902011-06-20 16:40:37 -07001665 /**
1666 * Implement this method to intercept hover events before they are handled
1667 * by child views.
1668 * <p>
1669 * This method is called before dispatching a hover event to a child of
1670 * the view group or to the view group's own {@link #onHoverEvent} to allow
1671 * the view group a chance to intercept the hover event.
1672 * This method can also be used to watch all pointer motions that occur within
1673 * the bounds of the view group even when the pointer is hovering over
1674 * a child of the view group rather than over the view group itself.
1675 * </p><p>
1676 * The view group can prevent its children from receiving hover events by
1677 * implementing this method and returning <code>true</code> to indicate
1678 * that it would like to intercept hover events. The view group must
1679 * continuously return <code>true</code> from {@link #onInterceptHoverEvent}
1680 * for as long as it wishes to continue intercepting hover events from
1681 * its children.
1682 * </p><p>
1683 * Interception preserves the invariant that at most one view can be
1684 * hovered at a time by transferring hover focus from the currently hovered
1685 * child to the view group or vice-versa as needed.
1686 * </p><p>
1687 * If this method returns <code>true</code> and a child is already hovered, then the
1688 * child view will first receive a hover exit event and then the view group
1689 * itself will receive a hover enter event in {@link #onHoverEvent}.
1690 * Likewise, if this method had previously returned <code>true</code> to intercept hover
1691 * events and instead returns <code>false</code> while the pointer is hovering
1692 * within the bounds of one of a child, then the view group will first receive a
1693 * hover exit event in {@link #onHoverEvent} and then the hovered child will
1694 * receive a hover enter event.
1695 * </p><p>
1696 * The default implementation always returns false.
1697 * </p>
1698 *
1699 * @param event The motion event that describes the hover.
1700 * @return True if the view group would like to intercept the hover event
1701 * and prevent its children from receiving it.
1702 */
1703 public boolean onInterceptHoverEvent(MotionEvent event) {
Svetoslav Ganov736c2752011-04-22 18:30:36 -07001704 return false;
1705 }
1706
Jeff Browna032cc02011-03-07 16:56:21 -08001707 private static MotionEvent obtainMotionEventNoHistoryOrSelf(MotionEvent event) {
1708 if (event.getHistorySize() == 0) {
1709 return event;
1710 }
1711 return MotionEvent.obtainNoHistory(event);
1712 }
1713
Jeff Brown10b62902011-06-20 16:40:37 -07001714 /**
1715 * {@inheritDoc}
1716 */
Jeff Browna032cc02011-03-07 16:56:21 -08001717 @Override
1718 protected boolean dispatchGenericPointerEvent(MotionEvent event) {
1719 // Send the event to the child under the pointer.
1720 final int childrenCount = mChildrenCount;
1721 if (childrenCount != 0) {
1722 final View[] children = mChildren;
1723 final float x = event.getX();
1724 final float y = event.getY();
1725
Adam Powella6478a32012-08-17 16:40:00 -07001726 final boolean customOrder = isChildrenDrawingOrderEnabled();
Jeff Browna032cc02011-03-07 16:56:21 -08001727 for (int i = childrenCount - 1; i >= 0; i--) {
Adam Powella6478a32012-08-17 16:40:00 -07001728 final int childIndex = customOrder ? getChildDrawingOrder(childrenCount, i) : i;
1729 final View child = children[childIndex];
Jeff Browna032cc02011-03-07 16:56:21 -08001730 if (!canViewReceivePointerEvents(child)
1731 || !isTransformedTouchPointInView(x, y, child, null)) {
1732 continue;
1733 }
1734
1735 if (dispatchTransformedGenericPointerEvent(event, child)) {
1736 return true;
1737 }
1738 }
1739 }
1740
1741 // No child handled the event. Send it to this view group.
1742 return super.dispatchGenericPointerEvent(event);
1743 }
1744
Jeff Brown10b62902011-06-20 16:40:37 -07001745 /**
1746 * {@inheritDoc}
1747 */
Jeff Browna032cc02011-03-07 16:56:21 -08001748 @Override
1749 protected boolean dispatchGenericFocusedEvent(MotionEvent event) {
Jeff Brown33bbfd22011-02-24 20:55:35 -08001750 // Send the event to the focused child or to this view group if it has focus.
Dianne Hackborn4702a852012-08-17 15:18:29 -07001751 if ((mPrivateFlags & (PFLAG_FOCUSED | PFLAG_HAS_BOUNDS))
1752 == (PFLAG_FOCUSED | PFLAG_HAS_BOUNDS)) {
Jeff Browna032cc02011-03-07 16:56:21 -08001753 return super.dispatchGenericFocusedEvent(event);
Dianne Hackborn4702a852012-08-17 15:18:29 -07001754 } else if (mFocused != null && (mFocused.mPrivateFlags & PFLAG_HAS_BOUNDS)
1755 == PFLAG_HAS_BOUNDS) {
Jeff Browncb1404e2011-01-15 18:14:15 -08001756 return mFocused.dispatchGenericMotionEvent(event);
1757 }
1758 return false;
1759 }
1760
1761 /**
Jeff Browna032cc02011-03-07 16:56:21 -08001762 * Dispatches a generic pointer event to a child, taking into account
1763 * transformations that apply to the child.
1764 *
1765 * @param event The event to send.
1766 * @param child The view to send the event to.
1767 * @return {@code true} if the child handled the event.
1768 */
1769 private boolean dispatchTransformedGenericPointerEvent(MotionEvent event, View child) {
1770 final float offsetX = mScrollX - child.mLeft;
1771 final float offsetY = mScrollY - child.mTop;
1772
1773 boolean handled;
1774 if (!child.hasIdentityMatrix()) {
1775 MotionEvent transformedEvent = MotionEvent.obtain(event);
1776 transformedEvent.offsetLocation(offsetX, offsetY);
1777 transformedEvent.transform(child.getInverseMatrix());
1778 handled = child.dispatchGenericMotionEvent(transformedEvent);
1779 transformedEvent.recycle();
1780 } else {
1781 event.offsetLocation(offsetX, offsetY);
1782 handled = child.dispatchGenericMotionEvent(event);
1783 event.offsetLocation(-offsetX, -offsetY);
1784 }
1785 return handled;
1786 }
1787
1788 /**
Jeff Browncb1404e2011-01-15 18:14:15 -08001789 * {@inheritDoc}
1790 */
1791 @Override
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001792 public boolean dispatchTouchEvent(MotionEvent ev) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08001793 if (mInputEventConsistencyVerifier != null) {
1794 mInputEventConsistencyVerifier.onTouchEvent(ev, 1);
1795 }
1796
Jeff Brownbbdc50b2011-04-19 23:46:52 -07001797 boolean handled = false;
1798 if (onFilterTouchEventForSecurity(ev)) {
1799 final int action = ev.getAction();
1800 final int actionMasked = action & MotionEvent.ACTION_MASK;
Jeff Brown85a31762010-09-01 17:01:00 -07001801
Jeff Brownbbdc50b2011-04-19 23:46:52 -07001802 // Handle an initial down.
1803 if (actionMasked == MotionEvent.ACTION_DOWN) {
1804 // Throw away all previous state when starting a new touch gesture.
1805 // The framework may have dropped the up or cancel event for the previous gesture
1806 // due to an app switch, ANR, or some other state change.
1807 cancelAndClearTouchTargets(ev);
1808 resetTouchState();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001809 }
Adam Powellb08013c2010-09-16 16:28:11 -07001810
Jeff Brownbbdc50b2011-04-19 23:46:52 -07001811 // Check for interception.
1812 final boolean intercepted;
Jeff Brown20e987b2010-08-23 12:01:02 -07001813 if (actionMasked == MotionEvent.ACTION_DOWN
Jeff Brownbbdc50b2011-04-19 23:46:52 -07001814 || mFirstTouchTarget != null) {
1815 final boolean disallowIntercept = (mGroupFlags & FLAG_DISALLOW_INTERCEPT) != 0;
1816 if (!disallowIntercept) {
1817 intercepted = onInterceptTouchEvent(ev);
1818 ev.setAction(action); // restore action in case it was changed
1819 } else {
1820 intercepted = false;
1821 }
1822 } else {
1823 // There are no touch targets and this action is not an initial down
1824 // so this view group continues to intercept touches.
1825 intercepted = true;
1826 }
Jeff Brown20e987b2010-08-23 12:01:02 -07001827
Jeff Brownbbdc50b2011-04-19 23:46:52 -07001828 // Check for cancelation.
1829 final boolean canceled = resetCancelNextUpFlag(this)
1830 || actionMasked == MotionEvent.ACTION_CANCEL;
Jeff Brown20e987b2010-08-23 12:01:02 -07001831
Jeff Brownbbdc50b2011-04-19 23:46:52 -07001832 // Update list of touch targets for pointer down, if needed.
1833 final boolean split = (mGroupFlags & FLAG_SPLIT_MOTION_EVENTS) != 0;
1834 TouchTarget newTouchTarget = null;
1835 boolean alreadyDispatchedToNewTouchTarget = false;
1836 if (!canceled && !intercepted) {
1837 if (actionMasked == MotionEvent.ACTION_DOWN
1838 || (split && actionMasked == MotionEvent.ACTION_POINTER_DOWN)
1839 || actionMasked == MotionEvent.ACTION_HOVER_MOVE) {
1840 final int actionIndex = ev.getActionIndex(); // always 0 for down
1841 final int idBitsToAssign = split ? 1 << ev.getPointerId(actionIndex)
1842 : TouchTarget.ALL_POINTER_IDS;
Jeff Brown20e987b2010-08-23 12:01:02 -07001843
Jeff Brownbbdc50b2011-04-19 23:46:52 -07001844 // Clean up earlier touch targets for this pointer id in case they
1845 // have become out of sync.
1846 removePointersFromTouchTargets(idBitsToAssign);
1847
1848 final int childrenCount = mChildrenCount;
1849 if (childrenCount != 0) {
1850 // Find a child that can receive the event.
1851 // Scan children from front to back.
1852 final View[] children = mChildren;
1853 final float x = ev.getX(actionIndex);
1854 final float y = ev.getY(actionIndex);
1855
Adam Powella6478a32012-08-17 16:40:00 -07001856 final boolean customOrder = isChildrenDrawingOrderEnabled();
Jeff Brownbbdc50b2011-04-19 23:46:52 -07001857 for (int i = childrenCount - 1; i >= 0; i--) {
Adam Powella6478a32012-08-17 16:40:00 -07001858 final int childIndex = customOrder ?
1859 getChildDrawingOrder(childrenCount, i) : i;
1860 final View child = children[childIndex];
Jeff Brownbbdc50b2011-04-19 23:46:52 -07001861 if (!canViewReceivePointerEvents(child)
1862 || !isTransformedTouchPointInView(x, y, child, null)) {
1863 continue;
1864 }
1865
1866 newTouchTarget = getTouchTarget(child);
1867 if (newTouchTarget != null) {
1868 // Child is already receiving touch within its bounds.
1869 // Give it the new pointer in addition to the ones it is handling.
1870 newTouchTarget.pointerIdBits |= idBitsToAssign;
1871 break;
1872 }
1873
1874 resetCancelNextUpFlag(child);
1875 if (dispatchTransformedTouchEvent(ev, false, child, idBitsToAssign)) {
1876 // Child wants to receive touch within its bounds.
1877 mLastTouchDownTime = ev.getDownTime();
Adam Powella6478a32012-08-17 16:40:00 -07001878 mLastTouchDownIndex = childIndex;
Jeff Brownbbdc50b2011-04-19 23:46:52 -07001879 mLastTouchDownX = ev.getX();
1880 mLastTouchDownY = ev.getY();
1881 newTouchTarget = addTouchTarget(child, idBitsToAssign);
1882 alreadyDispatchedToNewTouchTarget = true;
1883 break;
1884 }
1885 }
1886 }
1887
1888 if (newTouchTarget == null && mFirstTouchTarget != null) {
1889 // Did not find a child to receive the event.
1890 // Assign the pointer to the least recently added target.
1891 newTouchTarget = mFirstTouchTarget;
1892 while (newTouchTarget.next != null) {
1893 newTouchTarget = newTouchTarget.next;
1894 }
1895 newTouchTarget.pointerIdBits |= idBitsToAssign;
1896 }
1897 }
1898 }
1899
1900 // Dispatch to touch targets.
1901 if (mFirstTouchTarget == null) {
1902 // No touch targets so treat this as an ordinary view.
1903 handled = dispatchTransformedTouchEvent(ev, canceled, null,
1904 TouchTarget.ALL_POINTER_IDS);
1905 } else {
1906 // Dispatch to touch targets, excluding the new touch target if we already
1907 // dispatched to it. Cancel touch targets if necessary.
1908 TouchTarget predecessor = null;
1909 TouchTarget target = mFirstTouchTarget;
1910 while (target != null) {
1911 final TouchTarget next = target.next;
1912 if (alreadyDispatchedToNewTouchTarget && target == newTouchTarget) {
1913 handled = true;
1914 } else {
1915 final boolean cancelChild = resetCancelNextUpFlag(target.child)
1916 || intercepted;
1917 if (dispatchTransformedTouchEvent(ev, cancelChild,
1918 target.child, target.pointerIdBits)) {
1919 handled = true;
1920 }
1921 if (cancelChild) {
1922 if (predecessor == null) {
1923 mFirstTouchTarget = next;
1924 } else {
1925 predecessor.next = next;
1926 }
1927 target.recycle();
1928 target = next;
Jeff Brown20e987b2010-08-23 12:01:02 -07001929 continue;
1930 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001931 }
Jeff Brownbbdc50b2011-04-19 23:46:52 -07001932 predecessor = target;
1933 target = next;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001934 }
Jeff Brownbbdc50b2011-04-19 23:46:52 -07001935 }
Jeff Brown20e987b2010-08-23 12:01:02 -07001936
Jeff Brownbbdc50b2011-04-19 23:46:52 -07001937 // Update list of touch targets for pointer up or cancel, if needed.
1938 if (canceled
1939 || actionMasked == MotionEvent.ACTION_UP
1940 || actionMasked == MotionEvent.ACTION_HOVER_MOVE) {
1941 resetTouchState();
1942 } else if (split && actionMasked == MotionEvent.ACTION_POINTER_UP) {
1943 final int actionIndex = ev.getActionIndex();
1944 final int idBitsToRemove = 1 << ev.getPointerId(actionIndex);
1945 removePointersFromTouchTargets(idBitsToRemove);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001946 }
1947 }
Romain Guy8506ab42009-06-11 17:35:47 -07001948
Jeff Brownbbdc50b2011-04-19 23:46:52 -07001949 if (!handled && mInputEventConsistencyVerifier != null) {
1950 mInputEventConsistencyVerifier.onUnhandledEvent(ev, 1);
Jeff Brown20e987b2010-08-23 12:01:02 -07001951 }
Jeff Brown20e987b2010-08-23 12:01:02 -07001952 return handled;
1953 }
1954
Romain Guy469b1db2010-10-05 11:49:57 -07001955 /**
1956 * Resets all touch state in preparation for a new cycle.
1957 */
1958 private void resetTouchState() {
Jeff Brown20e987b2010-08-23 12:01:02 -07001959 clearTouchTargets();
1960 resetCancelNextUpFlag(this);
1961 mGroupFlags &= ~FLAG_DISALLOW_INTERCEPT;
1962 }
1963
Romain Guy469b1db2010-10-05 11:49:57 -07001964 /**
1965 * Resets the cancel next up flag.
1966 * Returns true if the flag was previously set.
1967 */
Romain Guya998dff2012-03-23 18:58:36 -07001968 private static boolean resetCancelNextUpFlag(View view) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07001969 if ((view.mPrivateFlags & PFLAG_CANCEL_NEXT_UP_EVENT) != 0) {
1970 view.mPrivateFlags &= ~PFLAG_CANCEL_NEXT_UP_EVENT;
Jeff Brown20e987b2010-08-23 12:01:02 -07001971 return true;
Adam Cohen9b073942010-08-19 16:49:52 -07001972 }
1973 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001974 }
1975
Romain Guy469b1db2010-10-05 11:49:57 -07001976 /**
1977 * Clears all touch targets.
1978 */
1979 private void clearTouchTargets() {
Jeff Brown20e987b2010-08-23 12:01:02 -07001980 TouchTarget target = mFirstTouchTarget;
1981 if (target != null) {
1982 do {
1983 TouchTarget next = target.next;
1984 target.recycle();
1985 target = next;
1986 } while (target != null);
1987 mFirstTouchTarget = null;
1988 }
1989 }
1990
Romain Guy469b1db2010-10-05 11:49:57 -07001991 /**
1992 * Cancels and clears all touch targets.
1993 */
1994 private void cancelAndClearTouchTargets(MotionEvent event) {
Jeff Brown20e987b2010-08-23 12:01:02 -07001995 if (mFirstTouchTarget != null) {
1996 boolean syntheticEvent = false;
1997 if (event == null) {
1998 final long now = SystemClock.uptimeMillis();
1999 event = MotionEvent.obtain(now, now,
2000 MotionEvent.ACTION_CANCEL, 0.0f, 0.0f, 0);
Jeff Brown2fdbc5a2011-06-30 12:25:54 -07002001 event.setSource(InputDevice.SOURCE_TOUCHSCREEN);
Jeff Brown20e987b2010-08-23 12:01:02 -07002002 syntheticEvent = true;
2003 }
2004
2005 for (TouchTarget target = mFirstTouchTarget; target != null; target = target.next) {
2006 resetCancelNextUpFlag(target.child);
2007 dispatchTransformedTouchEvent(event, true, target.child, target.pointerIdBits);
2008 }
2009 clearTouchTargets();
2010
2011 if (syntheticEvent) {
2012 event.recycle();
2013 }
2014 }
2015 }
2016
Romain Guy469b1db2010-10-05 11:49:57 -07002017 /**
2018 * Gets the touch target for specified child view.
2019 * Returns null if not found.
2020 */
2021 private TouchTarget getTouchTarget(View child) {
Jeff Brown20e987b2010-08-23 12:01:02 -07002022 for (TouchTarget target = mFirstTouchTarget; target != null; target = target.next) {
2023 if (target.child == child) {
2024 return target;
2025 }
2026 }
2027 return null;
2028 }
2029
Romain Guy469b1db2010-10-05 11:49:57 -07002030 /**
2031 * Adds a touch target for specified child to the beginning of the list.
2032 * Assumes the target child is not already present.
2033 */
2034 private TouchTarget addTouchTarget(View child, int pointerIdBits) {
Jeff Brown20e987b2010-08-23 12:01:02 -07002035 TouchTarget target = TouchTarget.obtain(child, pointerIdBits);
2036 target.next = mFirstTouchTarget;
2037 mFirstTouchTarget = target;
2038 return target;
2039 }
2040
Romain Guy469b1db2010-10-05 11:49:57 -07002041 /**
2042 * Removes the pointer ids from consideration.
2043 */
2044 private void removePointersFromTouchTargets(int pointerIdBits) {
Jeff Brown20e987b2010-08-23 12:01:02 -07002045 TouchTarget predecessor = null;
2046 TouchTarget target = mFirstTouchTarget;
2047 while (target != null) {
2048 final TouchTarget next = target.next;
2049 if ((target.pointerIdBits & pointerIdBits) != 0) {
2050 target.pointerIdBits &= ~pointerIdBits;
2051 if (target.pointerIdBits == 0) {
2052 if (predecessor == null) {
2053 mFirstTouchTarget = next;
2054 } else {
2055 predecessor.next = next;
2056 }
2057 target.recycle();
2058 target = next;
2059 continue;
2060 }
2061 }
2062 predecessor = target;
2063 target = next;
2064 }
2065 }
2066
Jeff Brown59a422e2012-04-19 15:19:19 -07002067 private void cancelTouchTarget(View view) {
2068 TouchTarget predecessor = null;
2069 TouchTarget target = mFirstTouchTarget;
2070 while (target != null) {
2071 final TouchTarget next = target.next;
2072 if (target.child == view) {
2073 if (predecessor == null) {
2074 mFirstTouchTarget = next;
2075 } else {
2076 predecessor.next = next;
2077 }
2078 target.recycle();
2079
2080 final long now = SystemClock.uptimeMillis();
2081 MotionEvent event = MotionEvent.obtain(now, now,
2082 MotionEvent.ACTION_CANCEL, 0.0f, 0.0f, 0);
2083 event.setSource(InputDevice.SOURCE_TOUCHSCREEN);
2084 view.dispatchTouchEvent(event);
2085 event.recycle();
2086 return;
2087 }
2088 predecessor = target;
2089 target = next;
2090 }
2091 }
2092
Romain Guy469b1db2010-10-05 11:49:57 -07002093 /**
Jeff Browna032cc02011-03-07 16:56:21 -08002094 * Returns true if a child view can receive pointer events.
2095 * @hide
2096 */
2097 private static boolean canViewReceivePointerEvents(View child) {
2098 return (child.mViewFlags & VISIBILITY_MASK) == VISIBLE
2099 || child.getAnimation() != null;
2100 }
2101
2102 /**
Romain Guy469b1db2010-10-05 11:49:57 -07002103 * Returns true if a child view contains the specified point when transformed
Jeff Brown20e987b2010-08-23 12:01:02 -07002104 * into its coordinate space.
Romain Guy469b1db2010-10-05 11:49:57 -07002105 * Child must not be null.
Adam Cohena32edd42010-10-26 10:35:01 -07002106 * @hide
Romain Guy469b1db2010-10-05 11:49:57 -07002107 */
Adam Cohena32edd42010-10-26 10:35:01 -07002108 protected boolean isTransformedTouchPointInView(float x, float y, View child,
Christopher Tate2c095f32010-10-04 14:13:40 -07002109 PointF outLocalPoint) {
Jeff Brown20e987b2010-08-23 12:01:02 -07002110 float localX = x + mScrollX - child.mLeft;
2111 float localY = y + mScrollY - child.mTop;
2112 if (! child.hasIdentityMatrix() && mAttachInfo != null) {
Adam Powell2b342f02010-08-18 18:14:13 -07002113 final float[] localXY = mAttachInfo.mTmpTransformLocation;
2114 localXY[0] = localX;
2115 localXY[1] = localY;
2116 child.getInverseMatrix().mapPoints(localXY);
2117 localX = localXY[0];
2118 localY = localXY[1];
2119 }
Christopher Tate2c095f32010-10-04 14:13:40 -07002120 final boolean isInView = child.pointInView(localX, localY);
2121 if (isInView && outLocalPoint != null) {
2122 outLocalPoint.set(localX, localY);
2123 }
2124 return isInView;
Adam Powell2b342f02010-08-18 18:14:13 -07002125 }
2126
Romain Guy469b1db2010-10-05 11:49:57 -07002127 /**
2128 * Transforms a motion event into the coordinate space of a particular child view,
Jeff Brown20e987b2010-08-23 12:01:02 -07002129 * filters out irrelevant pointer ids, and overrides its action if necessary.
Romain Guy469b1db2010-10-05 11:49:57 -07002130 * If child is null, assumes the MotionEvent will be sent to this ViewGroup instead.
2131 */
2132 private boolean dispatchTransformedTouchEvent(MotionEvent event, boolean cancel,
Jeff Brown20e987b2010-08-23 12:01:02 -07002133 View child, int desiredPointerIdBits) {
2134 final boolean handled;
Adam Powell2b342f02010-08-18 18:14:13 -07002135
Jeff Brown20e987b2010-08-23 12:01:02 -07002136 // Canceling motions is a special case. We don't need to perform any transformations
2137 // or filtering. The important part is the action, not the contents.
2138 final int oldAction = event.getAction();
2139 if (cancel || oldAction == MotionEvent.ACTION_CANCEL) {
2140 event.setAction(MotionEvent.ACTION_CANCEL);
2141 if (child == null) {
2142 handled = super.dispatchTouchEvent(event);
2143 } else {
2144 handled = child.dispatchTouchEvent(event);
2145 }
2146 event.setAction(oldAction);
2147 return handled;
2148 }
Adam Powell2b342f02010-08-18 18:14:13 -07002149
Jeff Brown20e987b2010-08-23 12:01:02 -07002150 // Calculate the number of pointers to deliver.
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07002151 final int oldPointerIdBits = event.getPointerIdBits();
2152 final int newPointerIdBits = oldPointerIdBits & desiredPointerIdBits;
Adam Powell2b342f02010-08-18 18:14:13 -07002153
Jeff Brown20e987b2010-08-23 12:01:02 -07002154 // If for some reason we ended up in an inconsistent state where it looks like we
2155 // might produce a motion event with no pointers in it, then drop the event.
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07002156 if (newPointerIdBits == 0) {
Jeff Brown20e987b2010-08-23 12:01:02 -07002157 return false;
2158 }
Adam Powell2b342f02010-08-18 18:14:13 -07002159
Jeff Brown20e987b2010-08-23 12:01:02 -07002160 // If the number of pointers is the same and we don't need to perform any fancy
2161 // irreversible transformations, then we can reuse the motion event for this
2162 // dispatch as long as we are careful to revert any changes we make.
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07002163 // Otherwise we need to make a copy.
2164 final MotionEvent transformedEvent;
2165 if (newPointerIdBits == oldPointerIdBits) {
2166 if (child == null || child.hasIdentityMatrix()) {
2167 if (child == null) {
2168 handled = super.dispatchTouchEvent(event);
2169 } else {
2170 final float offsetX = mScrollX - child.mLeft;
2171 final float offsetY = mScrollY - child.mTop;
2172 event.offsetLocation(offsetX, offsetY);
Adam Powell2b342f02010-08-18 18:14:13 -07002173
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07002174 handled = child.dispatchTouchEvent(event);
Jeff Brown20e987b2010-08-23 12:01:02 -07002175
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07002176 event.offsetLocation(-offsetX, -offsetY);
2177 }
2178 return handled;
Jeff Brown20e987b2010-08-23 12:01:02 -07002179 }
Jeff Brown20e987b2010-08-23 12:01:02 -07002180 transformedEvent = MotionEvent.obtain(event);
2181 } else {
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07002182 transformedEvent = event.split(newPointerIdBits);
Adam Powell2b342f02010-08-18 18:14:13 -07002183 }
2184
Jeff Brown20e987b2010-08-23 12:01:02 -07002185 // Perform any necessary transformations and dispatch.
2186 if (child == null) {
2187 handled = super.dispatchTouchEvent(transformedEvent);
2188 } else {
2189 final float offsetX = mScrollX - child.mLeft;
2190 final float offsetY = mScrollY - child.mTop;
2191 transformedEvent.offsetLocation(offsetX, offsetY);
2192 if (! child.hasIdentityMatrix()) {
2193 transformedEvent.transform(child.getInverseMatrix());
Adam Powell2b342f02010-08-18 18:14:13 -07002194 }
2195
Jeff Brown20e987b2010-08-23 12:01:02 -07002196 handled = child.dispatchTouchEvent(transformedEvent);
Adam Powell2b342f02010-08-18 18:14:13 -07002197 }
2198
Jeff Brown20e987b2010-08-23 12:01:02 -07002199 // Done.
2200 transformedEvent.recycle();
Adam Powell2b342f02010-08-18 18:14:13 -07002201 return handled;
2202 }
2203
Romain Guy469b1db2010-10-05 11:49:57 -07002204 /**
Adam Powell2b342f02010-08-18 18:14:13 -07002205 * Enable or disable the splitting of MotionEvents to multiple children during touch event
Jeff Brown995e7742010-12-22 16:59:36 -08002206 * dispatch. This behavior is enabled by default for applications that target an
2207 * SDK version of {@link Build.VERSION_CODES#HONEYCOMB} or newer.
Adam Powell2b342f02010-08-18 18:14:13 -07002208 *
2209 * <p>When this option is enabled MotionEvents may be split and dispatched to different child
2210 * views depending on where each pointer initially went down. This allows for user interactions
2211 * such as scrolling two panes of content independently, chording of buttons, and performing
2212 * independent gestures on different pieces of content.
2213 *
2214 * @param split <code>true</code> to allow MotionEvents to be split and dispatched to multiple
2215 * child views. <code>false</code> to only allow one child view to be the target of
2216 * any MotionEvent received by this ViewGroup.
2217 */
2218 public void setMotionEventSplittingEnabled(boolean split) {
2219 // TODO Applications really shouldn't change this setting mid-touch event,
2220 // but perhaps this should handle that case and send ACTION_CANCELs to any child views
2221 // with gestures in progress when this is changed.
2222 if (split) {
Adam Powell2b342f02010-08-18 18:14:13 -07002223 mGroupFlags |= FLAG_SPLIT_MOTION_EVENTS;
2224 } else {
2225 mGroupFlags &= ~FLAG_SPLIT_MOTION_EVENTS;
Adam Powell2b342f02010-08-18 18:14:13 -07002226 }
2227 }
2228
2229 /**
Jeff Brown995e7742010-12-22 16:59:36 -08002230 * Returns true if MotionEvents dispatched to this ViewGroup can be split to multiple children.
Adam Powell2b342f02010-08-18 18:14:13 -07002231 * @return true if MotionEvents dispatched to this ViewGroup can be split to multiple children.
2232 */
2233 public boolean isMotionEventSplittingEnabled() {
2234 return (mGroupFlags & FLAG_SPLIT_MOTION_EVENTS) == FLAG_SPLIT_MOTION_EVENTS;
2235 }
2236
2237 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002238 * {@inheritDoc}
2239 */
2240 public void requestDisallowInterceptTouchEvent(boolean disallowIntercept) {
Romain Guy8506ab42009-06-11 17:35:47 -07002241
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002242 if (disallowIntercept == ((mGroupFlags & FLAG_DISALLOW_INTERCEPT) != 0)) {
2243 // We're already in this state, assume our ancestors are too
2244 return;
2245 }
Romain Guy8506ab42009-06-11 17:35:47 -07002246
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002247 if (disallowIntercept) {
2248 mGroupFlags |= FLAG_DISALLOW_INTERCEPT;
2249 } else {
2250 mGroupFlags &= ~FLAG_DISALLOW_INTERCEPT;
2251 }
Romain Guy8506ab42009-06-11 17:35:47 -07002252
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002253 // Pass it up to our parent
2254 if (mParent != null) {
2255 mParent.requestDisallowInterceptTouchEvent(disallowIntercept);
2256 }
2257 }
2258
2259 /**
2260 * Implement this method to intercept all touch screen motion events. This
2261 * allows you to watch events as they are dispatched to your children, and
2262 * take ownership of the current gesture at any point.
2263 *
2264 * <p>Using this function takes some care, as it has a fairly complicated
2265 * interaction with {@link View#onTouchEvent(MotionEvent)
2266 * View.onTouchEvent(MotionEvent)}, and using it requires implementing
2267 * that method as well as this one in the correct way. Events will be
2268 * received in the following order:
2269 *
2270 * <ol>
2271 * <li> You will receive the down event here.
2272 * <li> The down event will be handled either by a child of this view
2273 * group, or given to your own onTouchEvent() method to handle; this means
2274 * you should implement onTouchEvent() to return true, so you will
2275 * continue to see the rest of the gesture (instead of looking for
2276 * a parent view to handle it). Also, by returning true from
2277 * onTouchEvent(), you will not receive any following
2278 * events in onInterceptTouchEvent() and all touch processing must
2279 * happen in onTouchEvent() like normal.
2280 * <li> For as long as you return false from this function, each following
2281 * event (up to and including the final up) will be delivered first here
2282 * and then to the target's onTouchEvent().
2283 * <li> If you return true from here, you will not receive any
2284 * following events: the target view will receive the same event but
2285 * with the action {@link MotionEvent#ACTION_CANCEL}, and all further
2286 * events will be delivered to your onTouchEvent() method and no longer
2287 * appear here.
2288 * </ol>
2289 *
2290 * @param ev The motion event being dispatched down the hierarchy.
2291 * @return Return true to steal motion events from the children and have
2292 * them dispatched to this ViewGroup through onTouchEvent().
2293 * The current target will receive an ACTION_CANCEL event, and no further
2294 * messages will be delivered here.
2295 */
2296 public boolean onInterceptTouchEvent(MotionEvent ev) {
2297 return false;
2298 }
2299
2300 /**
2301 * {@inheritDoc}
2302 *
2303 * Looks for a view to give focus to respecting the setting specified by
2304 * {@link #getDescendantFocusability()}.
2305 *
2306 * Uses {@link #onRequestFocusInDescendants(int, android.graphics.Rect)} to
2307 * find focus within the children of this group when appropriate.
2308 *
2309 * @see #FOCUS_BEFORE_DESCENDANTS
2310 * @see #FOCUS_AFTER_DESCENDANTS
2311 * @see #FOCUS_BLOCK_DESCENDANTS
Romain Guy02739a82011-05-16 11:43:18 -07002312 * @see #onRequestFocusInDescendants(int, android.graphics.Rect)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002313 */
2314 @Override
2315 public boolean requestFocus(int direction, Rect previouslyFocusedRect) {
2316 if (DBG) {
2317 System.out.println(this + " ViewGroup.requestFocus direction="
2318 + direction);
2319 }
2320 int descendantFocusability = getDescendantFocusability();
2321
2322 switch (descendantFocusability) {
2323 case FOCUS_BLOCK_DESCENDANTS:
2324 return super.requestFocus(direction, previouslyFocusedRect);
2325 case FOCUS_BEFORE_DESCENDANTS: {
2326 final boolean took = super.requestFocus(direction, previouslyFocusedRect);
2327 return took ? took : onRequestFocusInDescendants(direction, previouslyFocusedRect);
2328 }
2329 case FOCUS_AFTER_DESCENDANTS: {
2330 final boolean took = onRequestFocusInDescendants(direction, previouslyFocusedRect);
2331 return took ? took : super.requestFocus(direction, previouslyFocusedRect);
2332 }
2333 default:
2334 throw new IllegalStateException("descendant focusability must be "
2335 + "one of FOCUS_BEFORE_DESCENDANTS, FOCUS_AFTER_DESCENDANTS, FOCUS_BLOCK_DESCENDANTS "
2336 + "but is " + descendantFocusability);
2337 }
2338 }
2339
2340 /**
2341 * Look for a descendant to call {@link View#requestFocus} on.
2342 * Called by {@link ViewGroup#requestFocus(int, android.graphics.Rect)}
2343 * when it wants to request focus within its children. Override this to
2344 * customize how your {@link ViewGroup} requests focus within its children.
2345 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
2346 * @param previouslyFocusedRect The rectangle (in this View's coordinate system)
2347 * to give a finer grained hint about where focus is coming from. May be null
2348 * if there is no hint.
2349 * @return Whether focus was taken.
2350 */
2351 @SuppressWarnings({"ConstantConditions"})
2352 protected boolean onRequestFocusInDescendants(int direction,
2353 Rect previouslyFocusedRect) {
2354 int index;
2355 int increment;
2356 int end;
2357 int count = mChildrenCount;
2358 if ((direction & FOCUS_FORWARD) != 0) {
2359 index = 0;
2360 increment = 1;
2361 end = count;
2362 } else {
2363 index = count - 1;
2364 increment = -1;
2365 end = -1;
2366 }
2367 final View[] children = mChildren;
2368 for (int i = index; i != end; i += increment) {
2369 View child = children[i];
2370 if ((child.mViewFlags & VISIBILITY_MASK) == VISIBLE) {
2371 if (child.requestFocus(direction, previouslyFocusedRect)) {
2372 return true;
2373 }
2374 }
2375 }
2376 return false;
2377 }
Chet Haase5c13d892010-10-08 08:37:55 -07002378
Romain Guya440b002010-02-24 15:57:54 -08002379 /**
2380 * {@inheritDoc}
Chet Haase5c13d892010-10-08 08:37:55 -07002381 *
Romain Guydcc490f2010-02-24 17:59:35 -08002382 * @hide
Romain Guya440b002010-02-24 15:57:54 -08002383 */
2384 @Override
2385 public void dispatchStartTemporaryDetach() {
2386 super.dispatchStartTemporaryDetach();
2387 final int count = mChildrenCount;
2388 final View[] children = mChildren;
2389 for (int i = 0; i < count; i++) {
2390 children[i].dispatchStartTemporaryDetach();
2391 }
2392 }
Chet Haase5c13d892010-10-08 08:37:55 -07002393
Romain Guya440b002010-02-24 15:57:54 -08002394 /**
2395 * {@inheritDoc}
Chet Haase5c13d892010-10-08 08:37:55 -07002396 *
Romain Guydcc490f2010-02-24 17:59:35 -08002397 * @hide
Romain Guya440b002010-02-24 15:57:54 -08002398 */
2399 @Override
2400 public void dispatchFinishTemporaryDetach() {
2401 super.dispatchFinishTemporaryDetach();
2402 final int count = mChildrenCount;
2403 final View[] children = mChildren;
2404 for (int i = 0; i < count; i++) {
2405 children[i].dispatchFinishTemporaryDetach();
2406 }
2407 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002408
2409 /**
2410 * {@inheritDoc}
2411 */
2412 @Override
2413 void dispatchAttachedToWindow(AttachInfo info, int visibility) {
Adam Powell4b867882011-09-16 12:59:46 -07002414 mGroupFlags |= FLAG_PREVENT_DISPATCH_ATTACHED_TO_WINDOW;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002415 super.dispatchAttachedToWindow(info, visibility);
Adam Powell4b867882011-09-16 12:59:46 -07002416 mGroupFlags &= ~FLAG_PREVENT_DISPATCH_ATTACHED_TO_WINDOW;
2417
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002418 final int count = mChildrenCount;
2419 final View[] children = mChildren;
2420 for (int i = 0; i < count; i++) {
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002421 final View child = children[i];
2422 child.dispatchAttachedToWindow(info,
2423 visibility | (child.mViewFlags&VISIBILITY_MASK));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002424 }
2425 }
2426
svetoslavganov75986cf2009-05-14 22:28:01 -07002427 @Override
Romain Guybb9908b2012-03-08 11:14:07 -08002428 void dispatchScreenStateChanged(int screenState) {
2429 super.dispatchScreenStateChanged(screenState);
2430
2431 final int count = mChildrenCount;
2432 final View[] children = mChildren;
2433 for (int i = 0; i < count; i++) {
2434 children[i].dispatchScreenStateChanged(screenState);
2435 }
2436 }
2437
2438 @Override
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07002439 boolean dispatchPopulateAccessibilityEventInternal(AccessibilityEvent event) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07002440 boolean handled = false;
2441 if (includeForAccessibility()) {
2442 handled = super.dispatchPopulateAccessibilityEventInternal(event);
2443 if (handled) {
2444 return handled;
2445 }
Svetoslav Ganovb84b94e2011-09-22 19:26:56 -07002446 }
Svetoslav Ganov736c2752011-04-22 18:30:36 -07002447 // Let our children have a shot in populating the event.
Svetoslav Ganov42138042012-03-20 11:51:39 -07002448 ChildListForAccessibility children = ChildListForAccessibility.obtain(this, true);
Svetoslav Ganov76f287e2012-04-23 11:02:36 -07002449 try {
2450 final int childCount = children.getChildCount();
2451 for (int i = 0; i < childCount; i++) {
2452 View child = children.getChildAt(i);
2453 if ((child.mViewFlags & VISIBILITY_MASK) == VISIBLE) {
2454 handled = child.dispatchPopulateAccessibilityEvent(event);
2455 if (handled) {
Svetoslav Ganov76f287e2012-04-23 11:02:36 -07002456 return handled;
2457 }
Svetoslav Ganov6179ea32011-06-28 01:12:41 -07002458 }
Svetoslav Ganov736c2752011-04-22 18:30:36 -07002459 }
Svetoslav Ganov76f287e2012-04-23 11:02:36 -07002460 } finally {
2461 children.recycle();
svetoslavganov75986cf2009-05-14 22:28:01 -07002462 }
Svetoslav Ganov736c2752011-04-22 18:30:36 -07002463 return false;
svetoslavganov75986cf2009-05-14 22:28:01 -07002464 }
2465
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07002466 @Override
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07002467 void onInitializeAccessibilityNodeInfoInternal(AccessibilityNodeInfo info) {
2468 super.onInitializeAccessibilityNodeInfoInternal(info);
Svetoslav Ganov42138042012-03-20 11:51:39 -07002469 if (mAttachInfo != null) {
2470 ArrayList<View> childrenForAccessibility = mAttachInfo.mTempArrayList;
2471 childrenForAccessibility.clear();
2472 addChildrenForAccessibility(childrenForAccessibility);
2473 final int childrenForAccessibilityCount = childrenForAccessibility.size();
2474 for (int i = 0; i < childrenForAccessibilityCount; i++) {
2475 View child = childrenForAccessibility.get(i);
Svetoslav Ganovea1da3d2011-06-15 17:16:02 -07002476 info.addChild(child);
2477 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07002478 childrenForAccessibility.clear();
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07002479 }
2480 }
2481
Svetoslav Ganov8a78fd42012-01-17 14:36:46 -08002482 @Override
2483 void onInitializeAccessibilityEventInternal(AccessibilityEvent event) {
2484 super.onInitializeAccessibilityEventInternal(event);
2485 event.setClassName(ViewGroup.class.getName());
2486 }
2487
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002488 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -07002489 * @hide
2490 */
2491 @Override
2492 public void resetAccessibilityStateChanged() {
2493 super.resetAccessibilityStateChanged();
2494 View[] children = mChildren;
2495 final int childCount = mChildrenCount;
2496 for (int i = 0; i < childCount; i++) {
2497 View child = children[i];
2498 child.resetAccessibilityStateChanged();
2499 }
2500 }
2501
2502 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002503 * {@inheritDoc}
2504 */
2505 @Override
2506 void dispatchDetachedFromWindow() {
Jeff Brown20e987b2010-08-23 12:01:02 -07002507 // If we still have a touch target, we are still in the process of
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002508 // dispatching motion events to a child; we need to get rid of that
2509 // child to avoid dispatching events to it after the window is torn
2510 // down. To make sure we keep the child in a consistent state, we
2511 // first send it an ACTION_CANCEL motion event.
Jeff Brown20e987b2010-08-23 12:01:02 -07002512 cancelAndClearTouchTargets(null);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002513
Jeff Brown59a422e2012-04-19 15:19:19 -07002514 // Similarly, set ACTION_EXIT to all hover targets and clear them.
2515 exitHoverTargets();
2516
Chet Haase9c087442011-01-12 16:20:16 -08002517 // In case view is detached while transition is running
2518 mLayoutSuppressed = false;
2519
Christopher Tate86cab1b2011-01-13 20:28:55 -08002520 // Tear down our drag tracking
2521 mDragNotifiedChildren = null;
2522 if (mCurrentDrag != null) {
2523 mCurrentDrag.recycle();
2524 mCurrentDrag = null;
2525 }
2526
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002527 final int count = mChildrenCount;
2528 final View[] children = mChildren;
2529 for (int i = 0; i < count; i++) {
2530 children[i].dispatchDetachedFromWindow();
2531 }
2532 super.dispatchDetachedFromWindow();
2533 }
2534
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07002535 /**
2536 * @hide
2537 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002538 @Override
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07002539 protected void internalSetPadding(int left, int top, int right, int bottom) {
Romain Guy2440e672012-08-07 14:43:43 -07002540 super.internalSetPadding(left, top, right, bottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002541
Romain Guy13f35f32011-03-24 12:03:17 -07002542 if ((mPaddingLeft | mPaddingTop | mPaddingRight | mPaddingBottom) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002543 mGroupFlags |= FLAG_PADDING_NOT_NULL;
2544 } else {
2545 mGroupFlags &= ~FLAG_PADDING_NOT_NULL;
2546 }
2547 }
2548
2549 /**
2550 * {@inheritDoc}
2551 */
2552 @Override
2553 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) {
2554 super.dispatchSaveInstanceState(container);
2555 final int count = mChildrenCount;
2556 final View[] children = mChildren;
2557 for (int i = 0; i < count; i++) {
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07002558 View c = children[i];
2559 if ((c.mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED) {
2560 c.dispatchSaveInstanceState(container);
2561 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002562 }
2563 }
2564
2565 /**
Romain Guy9fc27812011-04-27 14:21:41 -07002566 * Perform dispatching of a {@link #saveHierarchyState(android.util.SparseArray)} freeze()}
2567 * to only this view, not to its children. For use when overriding
2568 * {@link #dispatchSaveInstanceState(android.util.SparseArray)} dispatchFreeze()} to allow
2569 * subclasses to freeze their own state but not the state of their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002570 *
2571 * @param container the container
2572 */
2573 protected void dispatchFreezeSelfOnly(SparseArray<Parcelable> container) {
2574 super.dispatchSaveInstanceState(container);
2575 }
2576
2577 /**
2578 * {@inheritDoc}
2579 */
2580 @Override
2581 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) {
2582 super.dispatchRestoreInstanceState(container);
2583 final int count = mChildrenCount;
2584 final View[] children = mChildren;
2585 for (int i = 0; i < count; i++) {
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07002586 View c = children[i];
2587 if ((c.mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED) {
2588 c.dispatchRestoreInstanceState(container);
2589 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002590 }
2591 }
2592
2593 /**
Romain Guy02739a82011-05-16 11:43:18 -07002594 * Perform dispatching of a {@link #restoreHierarchyState(android.util.SparseArray)}
2595 * to only this view, not to its children. For use when overriding
2596 * {@link #dispatchRestoreInstanceState(android.util.SparseArray)} to allow
2597 * subclasses to thaw their own state but not the state of their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002598 *
2599 * @param container the container
2600 */
2601 protected void dispatchThawSelfOnly(SparseArray<Parcelable> container) {
2602 super.dispatchRestoreInstanceState(container);
2603 }
2604
2605 /**
2606 * Enables or disables the drawing cache for each child of this view group.
2607 *
2608 * @param enabled true to enable the cache, false to dispose of it
2609 */
2610 protected void setChildrenDrawingCacheEnabled(boolean enabled) {
2611 if (enabled || (mPersistentDrawingCache & PERSISTENT_ALL_CACHES) != PERSISTENT_ALL_CACHES) {
2612 final View[] children = mChildren;
2613 final int count = mChildrenCount;
2614 for (int i = 0; i < count; i++) {
2615 children[i].setDrawingCacheEnabled(enabled);
2616 }
2617 }
2618 }
2619
2620 @Override
2621 protected void onAnimationStart() {
2622 super.onAnimationStart();
2623
2624 // When this ViewGroup's animation starts, build the cache for the children
2625 if ((mGroupFlags & FLAG_ANIMATION_CACHE) == FLAG_ANIMATION_CACHE) {
2626 final int count = mChildrenCount;
2627 final View[] children = mChildren;
Romain Guy0d9275e2010-10-26 14:22:30 -07002628 final boolean buildCache = !isHardwareAccelerated();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002629
2630 for (int i = 0; i < count; i++) {
2631 final View child = children[i];
2632 if ((child.mViewFlags & VISIBILITY_MASK) == VISIBLE) {
2633 child.setDrawingCacheEnabled(true);
Romain Guy0d9275e2010-10-26 14:22:30 -07002634 if (buildCache) {
2635 child.buildDrawingCache(true);
2636 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002637 }
2638 }
2639
2640 mGroupFlags |= FLAG_CHILDREN_DRAWN_WITH_CACHE;
2641 }
2642 }
2643
2644 @Override
2645 protected void onAnimationEnd() {
2646 super.onAnimationEnd();
2647
2648 // When this ViewGroup's animation ends, destroy the cache of the children
2649 if ((mGroupFlags & FLAG_ANIMATION_CACHE) == FLAG_ANIMATION_CACHE) {
2650 mGroupFlags &= ~FLAG_CHILDREN_DRAWN_WITH_CACHE;
2651
2652 if ((mPersistentDrawingCache & PERSISTENT_ANIMATION_CACHE) == 0) {
2653 setChildrenDrawingCacheEnabled(false);
2654 }
2655 }
2656 }
2657
Romain Guy223ff5c2010-03-02 17:07:47 -08002658 @Override
2659 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) {
Romain Guy65554f22010-03-22 18:58:21 -07002660 int count = mChildrenCount;
2661 int[] visibilities = null;
2662
Romain Guy223ff5c2010-03-02 17:07:47 -08002663 if (skipChildren) {
Romain Guy65554f22010-03-22 18:58:21 -07002664 visibilities = new int[count];
2665 for (int i = 0; i < count; i++) {
2666 View child = getChildAt(i);
2667 visibilities[i] = child.getVisibility();
2668 if (visibilities[i] == View.VISIBLE) {
2669 child.setVisibility(INVISIBLE);
2670 }
2671 }
Romain Guy223ff5c2010-03-02 17:07:47 -08002672 }
2673
2674 Bitmap b = super.createSnapshot(quality, backgroundColor, skipChildren);
Romain Guy65554f22010-03-22 18:58:21 -07002675
2676 if (skipChildren) {
2677 for (int i = 0; i < count; i++) {
2678 getChildAt(i).setVisibility(visibilities[i]);
Chet Haase5c13d892010-10-08 08:37:55 -07002679 }
Romain Guy65554f22010-03-22 18:58:21 -07002680 }
Romain Guy223ff5c2010-03-02 17:07:47 -08002681
2682 return b;
2683 }
2684
Philip Milne604f4402012-04-24 19:27:11 -07002685 private static void drawRect(Canvas canvas, int x1, int y1, int x2, int y2, int color) {
2686 Paint paint = getDebugPaint();
2687 paint.setColor(color);
Romain Guycbc67742012-04-27 16:12:57 -07002688
2689 canvas.drawLines(getDebugLines(x1, y1, x2, y2), paint);
Philip Milne10ca24a2012-04-23 15:38:27 -07002690 }
2691
2692 /**
2693 * @hide
2694 */
2695 protected void onDebugDrawMargins(Canvas canvas) {
2696 for (int i = 0; i < getChildCount(); i++) {
2697 View c = getChildAt(i);
Philip Milne604f4402012-04-24 19:27:11 -07002698 c.getLayoutParams().onDebugDraw(c, canvas);
Philip Milne10ca24a2012-04-23 15:38:27 -07002699 }
2700 }
2701
2702 /**
2703 * @hide
2704 */
2705 protected void onDebugDraw(Canvas canvas) {
Philip Milne10ca24a2012-04-23 15:38:27 -07002706 // Draw optical bounds
Philip Milne7a23b492012-04-24 22:12:36 -07002707 if (getLayoutMode() == OPTICAL_BOUNDS) {
Philip Milne10ca24a2012-04-23 15:38:27 -07002708 for (int i = 0; i < getChildCount(); i++) {
2709 View c = getChildAt(i);
Philip Milne7a23b492012-04-24 22:12:36 -07002710 Insets insets = c.getOpticalInsets();
Philip Milne10ca24a2012-04-23 15:38:27 -07002711 drawRect(canvas,
2712 c.getLeft() + insets.left,
2713 c.getTop() + insets.top,
2714 c.getRight() - insets.right,
Philip Milne604f4402012-04-24 19:27:11 -07002715 c.getBottom() - insets.bottom, Color.RED);
Philip Milne10ca24a2012-04-23 15:38:27 -07002716 }
2717 }
2718
Philip Milne10ca24a2012-04-23 15:38:27 -07002719 // Draw margins
2720 onDebugDrawMargins(canvas);
Philip Milne604f4402012-04-24 19:27:11 -07002721
2722 // Draw bounds
2723 for (int i = 0; i < getChildCount(); i++) {
2724 View c = getChildAt(i);
2725 drawRect(canvas, c.getLeft(), c.getTop(), c.getRight(), c.getBottom(), Color.BLUE);
2726 }
Philip Milne10ca24a2012-04-23 15:38:27 -07002727 }
2728
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002729 /**
2730 * {@inheritDoc}
2731 */
2732 @Override
2733 protected void dispatchDraw(Canvas canvas) {
2734 final int count = mChildrenCount;
2735 final View[] children = mChildren;
2736 int flags = mGroupFlags;
2737
2738 if ((flags & FLAG_RUN_ANIMATION) != 0 && canAnimate()) {
2739 final boolean cache = (mGroupFlags & FLAG_ANIMATION_CACHE) == FLAG_ANIMATION_CACHE;
2740
Romain Guy0d9275e2010-10-26 14:22:30 -07002741 final boolean buildCache = !isHardwareAccelerated();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002742 for (int i = 0; i < count; i++) {
2743 final View child = children[i];
2744 if ((child.mViewFlags & VISIBILITY_MASK) == VISIBLE) {
2745 final LayoutParams params = child.getLayoutParams();
2746 attachLayoutAnimationParameters(child, params, i, count);
2747 bindLayoutAnimation(child);
2748 if (cache) {
2749 child.setDrawingCacheEnabled(true);
Romain Guy0d9275e2010-10-26 14:22:30 -07002750 if (buildCache) {
2751 child.buildDrawingCache(true);
2752 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002753 }
2754 }
2755 }
2756
2757 final LayoutAnimationController controller = mLayoutAnimationController;
2758 if (controller.willOverlap()) {
2759 mGroupFlags |= FLAG_OPTIMIZE_INVALIDATE;
2760 }
2761
2762 controller.start();
2763
2764 mGroupFlags &= ~FLAG_RUN_ANIMATION;
2765 mGroupFlags &= ~FLAG_ANIMATION_DONE;
2766
2767 if (cache) {
2768 mGroupFlags |= FLAG_CHILDREN_DRAWN_WITH_CACHE;
2769 }
2770
2771 if (mAnimationListener != null) {
2772 mAnimationListener.onAnimationStart(controller.getAnimation());
2773 }
2774 }
2775
2776 int saveCount = 0;
2777 final boolean clipToPadding = (flags & CLIP_TO_PADDING_MASK) == CLIP_TO_PADDING_MASK;
2778 if (clipToPadding) {
2779 saveCount = canvas.save();
Romain Guy8f2d94f2009-03-25 18:04:42 -07002780 canvas.clipRect(mScrollX + mPaddingLeft, mScrollY + mPaddingTop,
2781 mScrollX + mRight - mLeft - mPaddingRight,
2782 mScrollY + mBottom - mTop - mPaddingBottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002783
2784 }
2785
2786 // We will draw our child's animation, let's reset the flag
Dianne Hackborn4702a852012-08-17 15:18:29 -07002787 mPrivateFlags &= ~PFLAG_DRAW_ANIMATION;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002788 mGroupFlags &= ~FLAG_INVALIDATE_REQUIRED;
2789
2790 boolean more = false;
2791 final long drawingTime = getDrawingTime();
2792
2793 if ((flags & FLAG_USE_CHILD_DRAWING_ORDER) == 0) {
2794 for (int i = 0; i < count; i++) {
2795 final View child = children[i];
2796 if ((child.mViewFlags & VISIBILITY_MASK) == VISIBLE || child.getAnimation() != null) {
2797 more |= drawChild(canvas, child, drawingTime);
2798 }
2799 }
2800 } else {
2801 for (int i = 0; i < count; i++) {
2802 final View child = children[getChildDrawingOrder(count, i)];
2803 if ((child.mViewFlags & VISIBILITY_MASK) == VISIBLE || child.getAnimation() != null) {
2804 more |= drawChild(canvas, child, drawingTime);
2805 }
2806 }
2807 }
2808
2809 // Draw any disappearing views that have animations
2810 if (mDisappearingChildren != null) {
2811 final ArrayList<View> disappearingChildren = mDisappearingChildren;
2812 final int disappearingCount = disappearingChildren.size() - 1;
2813 // Go backwards -- we may delete as animations finish
2814 for (int i = disappearingCount; i >= 0; i--) {
2815 final View child = disappearingChildren.get(i);
2816 more |= drawChild(canvas, child, drawingTime);
2817 }
2818 }
2819
Philip Milne10ca24a2012-04-23 15:38:27 -07002820 if (debugDraw()) {
2821 onDebugDraw(canvas);
2822 }
2823
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002824 if (clipToPadding) {
2825 canvas.restoreToCount(saveCount);
2826 }
2827
2828 // mGroupFlags might have been updated by drawChild()
2829 flags = mGroupFlags;
2830
2831 if ((flags & FLAG_INVALIDATE_REQUIRED) == FLAG_INVALIDATE_REQUIRED) {
Romain Guy849d0a32011-02-01 17:20:48 -08002832 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002833 }
2834
2835 if ((flags & FLAG_ANIMATION_DONE) == 0 && (flags & FLAG_NOTIFY_ANIMATION_LISTENER) == 0 &&
2836 mLayoutAnimationController.isDone() && !more) {
2837 // We want to erase the drawing cache and notify the listener after the
2838 // next frame is drawn because one extra invalidate() is caused by
2839 // drawChild() after the animation is over
2840 mGroupFlags |= FLAG_NOTIFY_ANIMATION_LISTENER;
2841 final Runnable end = new Runnable() {
2842 public void run() {
2843 notifyAnimationListener();
2844 }
2845 };
2846 post(end);
2847 }
2848 }
Romain Guy8506ab42009-06-11 17:35:47 -07002849
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002850 /**
2851 * Returns the index of the child to draw for this iteration. Override this
2852 * if you want to change the drawing order of children. By default, it
2853 * returns i.
2854 * <p>
Romain Guy293451e2009-11-04 13:59:48 -08002855 * NOTE: In order for this method to be called, you must enable child ordering
2856 * first by calling {@link #setChildrenDrawingOrderEnabled(boolean)}.
Romain Guy8506ab42009-06-11 17:35:47 -07002857 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002858 * @param i The current iteration.
2859 * @return The index of the child to draw this iteration.
Chet Haase5c13d892010-10-08 08:37:55 -07002860 *
Romain Guy293451e2009-11-04 13:59:48 -08002861 * @see #setChildrenDrawingOrderEnabled(boolean)
2862 * @see #isChildrenDrawingOrderEnabled()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002863 */
2864 protected int getChildDrawingOrder(int childCount, int i) {
2865 return i;
2866 }
Romain Guy8506ab42009-06-11 17:35:47 -07002867
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002868 private void notifyAnimationListener() {
2869 mGroupFlags &= ~FLAG_NOTIFY_ANIMATION_LISTENER;
2870 mGroupFlags |= FLAG_ANIMATION_DONE;
2871
2872 if (mAnimationListener != null) {
2873 final Runnable end = new Runnable() {
2874 public void run() {
2875 mAnimationListener.onAnimationEnd(mLayoutAnimationController.getAnimation());
2876 }
2877 };
2878 post(end);
2879 }
2880
2881 if ((mGroupFlags & FLAG_ANIMATION_CACHE) == FLAG_ANIMATION_CACHE) {
2882 mGroupFlags &= ~FLAG_CHILDREN_DRAWN_WITH_CACHE;
2883 if ((mPersistentDrawingCache & PERSISTENT_ANIMATION_CACHE) == 0) {
2884 setChildrenDrawingCacheEnabled(false);
2885 }
2886 }
2887
Romain Guy849d0a32011-02-01 17:20:48 -08002888 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002889 }
2890
2891 /**
Chet Haasedaf98e92011-01-10 14:10:36 -08002892 * This method is used to cause children of this ViewGroup to restore or recreate their
2893 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need
2894 * to recreate its own display list, which would happen if it went through the normal
2895 * draw/dispatchDraw mechanisms.
2896 *
2897 * @hide
2898 */
2899 @Override
2900 protected void dispatchGetDisplayList() {
2901 final int count = mChildrenCount;
2902 final View[] children = mChildren;
2903 for (int i = 0; i < count; i++) {
2904 final View child = children[i];
Romain Guy59c7f802011-09-29 17:21:45 -07002905 if (((child.mViewFlags & VISIBILITY_MASK) == VISIBLE || child.getAnimation() != null) &&
2906 child.hasStaticLayer()) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07002907 child.mRecreateDisplayList = (child.mPrivateFlags & PFLAG_INVALIDATED)
2908 == PFLAG_INVALIDATED;
2909 child.mPrivateFlags &= ~PFLAG_INVALIDATED;
Romain Guy2f57ba52011-02-03 18:03:29 -08002910 child.getDisplayList();
2911 child.mRecreateDisplayList = false;
2912 }
Chet Haasedaf98e92011-01-10 14:10:36 -08002913 }
2914 }
2915
2916 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002917 * Draw one child of this View Group. This method is responsible for getting
2918 * the canvas in the right state. This includes clipping, translating so
2919 * that the child's scrolled origin is at 0, 0, and applying any animation
2920 * transformations.
2921 *
2922 * @param canvas The canvas on which to draw the child
2923 * @param child Who to draw
Chet Haasebcca79a2012-02-14 08:45:14 -08002924 * @param drawingTime The time at which draw is occurring
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002925 * @return True if an invalidate() was issued
2926 */
2927 protected boolean drawChild(Canvas canvas, View child, long drawingTime) {
Chet Haase64a48c12012-02-13 16:33:29 -08002928 return child.draw(canvas, this, drawingTime);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002929 }
2930
2931 /**
2932 * By default, children are clipped to their bounds before drawing. This
2933 * allows view groups to override this behavior for animations, etc.
2934 *
2935 * @param clipChildren true to clip children to their bounds,
2936 * false otherwise
2937 * @attr ref android.R.styleable#ViewGroup_clipChildren
2938 */
2939 public void setClipChildren(boolean clipChildren) {
Chet Haasea1cff502012-02-21 13:43:44 -08002940 boolean previousValue = (mGroupFlags & FLAG_CLIP_CHILDREN) == FLAG_CLIP_CHILDREN;
2941 if (clipChildren != previousValue) {
2942 setBooleanFlag(FLAG_CLIP_CHILDREN, clipChildren);
Chet Haase1271e2c2012-04-20 09:54:27 -07002943 for (int i = 0; i < mChildrenCount; ++i) {
2944 View child = getChildAt(i);
2945 if (child.mDisplayList != null) {
2946 child.mDisplayList.setClipChildren(clipChildren);
Chet Haasea1cff502012-02-21 13:43:44 -08002947 }
2948 }
2949 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002950 }
2951
2952 /**
2953 * By default, children are clipped to the padding of the ViewGroup. This
2954 * allows view groups to override this behavior
2955 *
2956 * @param clipToPadding true to clip children to the padding of the
2957 * group, false otherwise
2958 * @attr ref android.R.styleable#ViewGroup_clipToPadding
2959 */
2960 public void setClipToPadding(boolean clipToPadding) {
2961 setBooleanFlag(FLAG_CLIP_TO_PADDING, clipToPadding);
2962 }
2963
2964 /**
2965 * {@inheritDoc}
2966 */
2967 @Override
2968 public void dispatchSetSelected(boolean selected) {
2969 final View[] children = mChildren;
2970 final int count = mChildrenCount;
2971 for (int i = 0; i < count; i++) {
2972 children[i].setSelected(selected);
2973 }
2974 }
Romain Guy8506ab42009-06-11 17:35:47 -07002975
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07002976 /**
2977 * {@inheritDoc}
2978 */
2979 @Override
2980 public void dispatchSetActivated(boolean activated) {
2981 final View[] children = mChildren;
2982 final int count = mChildrenCount;
2983 for (int i = 0; i < count; i++) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07002984 children[i].setActivated(activated);
2985 }
2986 }
2987
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002988 @Override
2989 protected void dispatchSetPressed(boolean pressed) {
2990 final View[] children = mChildren;
2991 final int count = mChildrenCount;
2992 for (int i = 0; i < count; i++) {
Adam Powell035a1fc2012-02-27 15:23:50 -08002993 final View child = children[i];
2994 // Children that are clickable on their own should not
2995 // show a pressed state when their parent view does.
2996 // Clearing a pressed state always propagates.
2997 if (!pressed || (!child.isClickable() && !child.isLongClickable())) {
2998 child.setPressed(pressed);
2999 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003000 }
3001 }
3002
3003 /**
3004 * When this property is set to true, this ViewGroup supports static transformations on
3005 * children; this causes
3006 * {@link #getChildStaticTransformation(View, android.view.animation.Transformation)} to be
3007 * invoked when a child is drawn.
3008 *
3009 * Any subclass overriding
3010 * {@link #getChildStaticTransformation(View, android.view.animation.Transformation)} should
3011 * set this property to true.
3012 *
3013 * @param enabled True to enable static transformations on children, false otherwise.
3014 *
Chet Haase599913d2012-07-23 16:22:05 -07003015 * @see #getChildStaticTransformation(View, android.view.animation.Transformation)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003016 */
3017 protected void setStaticTransformationsEnabled(boolean enabled) {
3018 setBooleanFlag(FLAG_SUPPORT_STATIC_TRANSFORMATIONS, enabled);
3019 }
3020
3021 /**
Chet Haase2d46fcc2011-12-19 18:01:05 -08003022 * Sets <code>t</code> to be the static transformation of the child, if set, returning a
3023 * boolean to indicate whether a static transform was set. The default implementation
3024 * simply returns <code>false</code>; subclasses may override this method for different
Chet Haase599913d2012-07-23 16:22:05 -07003025 * behavior. {@link #setStaticTransformationsEnabled(boolean)} must be set to true
3026 * for this method to be called.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003027 *
Chet Haase2d46fcc2011-12-19 18:01:05 -08003028 * @param child The child view whose static transform is being requested
3029 * @param t The Transformation which will hold the result
3030 * @return true if the transformation was set, false otherwise
Romain Guy8506ab42009-06-11 17:35:47 -07003031 * @see #setStaticTransformationsEnabled(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003032 */
3033 protected boolean getChildStaticTransformation(View child, Transformation t) {
3034 return false;
3035 }
3036
3037 /**
3038 * {@hide}
3039 */
3040 @Override
3041 protected View findViewTraversal(int id) {
3042 if (id == mID) {
3043 return this;
3044 }
3045
3046 final View[] where = mChildren;
3047 final int len = mChildrenCount;
3048
3049 for (int i = 0; i < len; i++) {
3050 View v = where[i];
3051
Dianne Hackborn4702a852012-08-17 15:18:29 -07003052 if ((v.mPrivateFlags & PFLAG_IS_ROOT_NAMESPACE) == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003053 v = v.findViewById(id);
3054
3055 if (v != null) {
3056 return v;
3057 }
3058 }
3059 }
3060
3061 return null;
3062 }
3063
3064 /**
3065 * {@hide}
3066 */
3067 @Override
3068 protected View findViewWithTagTraversal(Object tag) {
3069 if (tag != null && tag.equals(mTag)) {
3070 return this;
3071 }
3072
3073 final View[] where = mChildren;
3074 final int len = mChildrenCount;
3075
3076 for (int i = 0; i < len; i++) {
3077 View v = where[i];
3078
Dianne Hackborn4702a852012-08-17 15:18:29 -07003079 if ((v.mPrivateFlags & PFLAG_IS_ROOT_NAMESPACE) == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003080 v = v.findViewWithTag(tag);
3081
3082 if (v != null) {
3083 return v;
3084 }
3085 }
3086 }
3087
3088 return null;
3089 }
3090
3091 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003092 * {@hide}
3093 */
3094 @Override
Jeff Brown4dfbec22011-08-15 14:55:37 -07003095 protected View findViewByPredicateTraversal(Predicate<View> predicate, View childToSkip) {
Jeff Brown4e6319b2010-12-13 10:36:51 -08003096 if (predicate.apply(this)) {
3097 return this;
3098 }
3099
3100 final View[] where = mChildren;
3101 final int len = mChildrenCount;
3102
3103 for (int i = 0; i < len; i++) {
3104 View v = where[i];
3105
Dianne Hackborn4702a852012-08-17 15:18:29 -07003106 if (v != childToSkip && (v.mPrivateFlags & PFLAG_IS_ROOT_NAMESPACE) == 0) {
Jeff Brown4e6319b2010-12-13 10:36:51 -08003107 v = v.findViewByPredicate(predicate);
3108
3109 if (v != null) {
3110 return v;
3111 }
3112 }
3113 }
3114
3115 return null;
3116 }
3117
3118 /**
Romain Guy393a52c2012-05-22 20:21:08 -07003119 * <p>Adds a child view. If no layout parameters are already set on the child, the
3120 * default parameters for this ViewGroup are set on the child.</p>
3121 *
3122 * <p><strong>Note:</strong> do not invoke this method from
3123 * {@link #draw(android.graphics.Canvas)}, {@link #onDraw(android.graphics.Canvas)},
3124 * {@link #dispatchDraw(android.graphics.Canvas)} or any related method.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003125 *
3126 * @param child the child view to add
3127 *
3128 * @see #generateDefaultLayoutParams()
3129 */
3130 public void addView(View child) {
3131 addView(child, -1);
3132 }
3133
3134 /**
3135 * Adds a child view. If no layout parameters are already set on the child, the
3136 * default parameters for this ViewGroup are set on the child.
Romain Guy393a52c2012-05-22 20:21:08 -07003137 *
3138 * <p><strong>Note:</strong> do not invoke this method from
3139 * {@link #draw(android.graphics.Canvas)}, {@link #onDraw(android.graphics.Canvas)},
3140 * {@link #dispatchDraw(android.graphics.Canvas)} or any related method.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003141 *
3142 * @param child the child view to add
3143 * @param index the position at which to add the child
3144 *
3145 * @see #generateDefaultLayoutParams()
3146 */
3147 public void addView(View child, int index) {
3148 LayoutParams params = child.getLayoutParams();
3149 if (params == null) {
3150 params = generateDefaultLayoutParams();
3151 if (params == null) {
3152 throw new IllegalArgumentException("generateDefaultLayoutParams() cannot return null");
3153 }
3154 }
3155 addView(child, index, params);
3156 }
3157
3158 /**
3159 * Adds a child view with this ViewGroup's default layout parameters and the
3160 * specified width and height.
3161 *
Romain Guy393a52c2012-05-22 20:21:08 -07003162 * <p><strong>Note:</strong> do not invoke this method from
3163 * {@link #draw(android.graphics.Canvas)}, {@link #onDraw(android.graphics.Canvas)},
3164 * {@link #dispatchDraw(android.graphics.Canvas)} or any related method.</p>
3165 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003166 * @param child the child view to add
3167 */
3168 public void addView(View child, int width, int height) {
3169 final LayoutParams params = generateDefaultLayoutParams();
3170 params.width = width;
3171 params.height = height;
3172 addView(child, -1, params);
3173 }
3174
3175 /**
3176 * Adds a child view with the specified layout parameters.
3177 *
Romain Guy393a52c2012-05-22 20:21:08 -07003178 * <p><strong>Note:</strong> do not invoke this method from
3179 * {@link #draw(android.graphics.Canvas)}, {@link #onDraw(android.graphics.Canvas)},
3180 * {@link #dispatchDraw(android.graphics.Canvas)} or any related method.</p>
3181 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003182 * @param child the child view to add
3183 * @param params the layout parameters to set on the child
3184 */
3185 public void addView(View child, LayoutParams params) {
3186 addView(child, -1, params);
3187 }
3188
3189 /**
3190 * Adds a child view with the specified layout parameters.
3191 *
Romain Guy393a52c2012-05-22 20:21:08 -07003192 * <p><strong>Note:</strong> do not invoke this method from
3193 * {@link #draw(android.graphics.Canvas)}, {@link #onDraw(android.graphics.Canvas)},
3194 * {@link #dispatchDraw(android.graphics.Canvas)} or any related method.</p>
3195 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003196 * @param child the child view to add
3197 * @param index the position at which to add the child
3198 * @param params the layout parameters to set on the child
3199 */
3200 public void addView(View child, int index, LayoutParams params) {
3201 if (DBG) {
3202 System.out.println(this + " addView");
3203 }
3204
3205 // addViewInner() will call child.requestLayout() when setting the new LayoutParams
3206 // therefore, we call requestLayout() on ourselves before, so that the child's request
3207 // will be blocked at our level
3208 requestLayout();
Romain Guy849d0a32011-02-01 17:20:48 -08003209 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003210 addViewInner(child, index, params, false);
3211 }
3212
3213 /**
3214 * {@inheritDoc}
3215 */
3216 public void updateViewLayout(View view, ViewGroup.LayoutParams params) {
3217 if (!checkLayoutParams(params)) {
3218 throw new IllegalArgumentException("Invalid LayoutParams supplied to " + this);
3219 }
3220 if (view.mParent != this) {
3221 throw new IllegalArgumentException("Given view not a child of " + this);
3222 }
3223 view.setLayoutParams(params);
3224 }
3225
3226 /**
3227 * {@inheritDoc}
3228 */
3229 protected boolean checkLayoutParams(ViewGroup.LayoutParams p) {
3230 return p != null;
3231 }
3232
3233 /**
3234 * Interface definition for a callback to be invoked when the hierarchy
3235 * within this view changed. The hierarchy changes whenever a child is added
3236 * to or removed from this view.
3237 */
3238 public interface OnHierarchyChangeListener {
3239 /**
3240 * Called when a new child is added to a parent view.
3241 *
3242 * @param parent the view in which a child was added
3243 * @param child the new child view added in the hierarchy
3244 */
3245 void onChildViewAdded(View parent, View child);
3246
3247 /**
3248 * Called when a child is removed from a parent view.
3249 *
3250 * @param parent the view from which the child was removed
3251 * @param child the child removed from the hierarchy
3252 */
3253 void onChildViewRemoved(View parent, View child);
3254 }
3255
3256 /**
3257 * Register a callback to be invoked when a child is added to or removed
3258 * from this view.
3259 *
3260 * @param listener the callback to invoke on hierarchy change
3261 */
3262 public void setOnHierarchyChangeListener(OnHierarchyChangeListener listener) {
3263 mOnHierarchyChangeListener = listener;
3264 }
3265
3266 /**
Philip Milnef51d91c2011-07-18 16:12:19 -07003267 * @hide
3268 */
3269 protected void onViewAdded(View child) {
3270 if (mOnHierarchyChangeListener != null) {
3271 mOnHierarchyChangeListener.onChildViewAdded(this, child);
3272 }
3273 }
3274
3275 /**
3276 * @hide
3277 */
3278 protected void onViewRemoved(View child) {
3279 if (mOnHierarchyChangeListener != null) {
3280 mOnHierarchyChangeListener.onChildViewRemoved(this, child);
3281 }
3282 }
3283
3284 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003285 * Adds a view during layout. This is useful if in your onLayout() method,
3286 * you need to add more views (as does the list view for example).
3287 *
3288 * If index is negative, it means put it at the end of the list.
3289 *
3290 * @param child the view to add to the group
3291 * @param index the index at which the child must be added
3292 * @param params the layout parameters to associate with the child
3293 * @return true if the child was added, false otherwise
3294 */
3295 protected boolean addViewInLayout(View child, int index, LayoutParams params) {
3296 return addViewInLayout(child, index, params, false);
3297 }
3298
3299 /**
3300 * Adds a view during layout. This is useful if in your onLayout() method,
3301 * you need to add more views (as does the list view for example).
3302 *
3303 * If index is negative, it means put it at the end of the list.
3304 *
3305 * @param child the view to add to the group
3306 * @param index the index at which the child must be added
3307 * @param params the layout parameters to associate with the child
3308 * @param preventRequestLayout if true, calling this method will not trigger a
3309 * layout request on child
3310 * @return true if the child was added, false otherwise
3311 */
3312 protected boolean addViewInLayout(View child, int index, LayoutParams params,
3313 boolean preventRequestLayout) {
3314 child.mParent = null;
3315 addViewInner(child, index, params, preventRequestLayout);
Dianne Hackborn4702a852012-08-17 15:18:29 -07003316 child.mPrivateFlags = (child.mPrivateFlags & ~PFLAG_DIRTY_MASK) | PFLAG_DRAWN;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003317 return true;
3318 }
3319
3320 /**
3321 * Prevents the specified child to be laid out during the next layout pass.
3322 *
3323 * @param child the child on which to perform the cleanup
3324 */
3325 protected void cleanupLayoutState(View child) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07003326 child.mPrivateFlags &= ~View.PFLAG_FORCE_LAYOUT;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003327 }
3328
3329 private void addViewInner(View child, int index, LayoutParams params,
3330 boolean preventRequestLayout) {
3331
Chet Haasee8e45d32011-03-02 17:07:35 -08003332 if (mTransition != null) {
3333 // Don't prevent other add transitions from completing, but cancel remove
3334 // transitions to let them complete the process before we add to the container
3335 mTransition.cancel(LayoutTransition.DISAPPEARING);
Chet Haaseadd65772011-02-09 16:47:29 -08003336 }
3337
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003338 if (child.getParent() != null) {
3339 throw new IllegalStateException("The specified child already has a parent. " +
3340 "You must call removeView() on the child's parent first.");
3341 }
3342
Chet Haase21cd1382010-09-01 17:42:29 -07003343 if (mTransition != null) {
Chet Haase5e25c2c2010-09-16 11:15:56 -07003344 mTransition.addChild(this, child);
Chet Haase21cd1382010-09-01 17:42:29 -07003345 }
3346
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003347 if (!checkLayoutParams(params)) {
3348 params = generateLayoutParams(params);
3349 }
3350
3351 if (preventRequestLayout) {
3352 child.mLayoutParams = params;
3353 } else {
3354 child.setLayoutParams(params);
3355 }
3356
3357 if (index < 0) {
3358 index = mChildrenCount;
3359 }
3360
3361 addInArray(child, index);
3362
3363 // tell our children
3364 if (preventRequestLayout) {
3365 child.assignParent(this);
3366 } else {
3367 child.mParent = this;
3368 }
3369
3370 if (child.hasFocus()) {
3371 requestChildFocus(child, child.findFocus());
3372 }
Romain Guy8506ab42009-06-11 17:35:47 -07003373
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003374 AttachInfo ai = mAttachInfo;
Adam Powell4b867882011-09-16 12:59:46 -07003375 if (ai != null && (mGroupFlags & FLAG_PREVENT_DISPATCH_ATTACHED_TO_WINDOW) == 0) {
Romain Guy8506ab42009-06-11 17:35:47 -07003376 boolean lastKeepOn = ai.mKeepScreenOn;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003377 ai.mKeepScreenOn = false;
3378 child.dispatchAttachedToWindow(mAttachInfo, (mViewFlags&VISIBILITY_MASK));
3379 if (ai.mKeepScreenOn) {
3380 needGlobalAttributesUpdate(true);
3381 }
3382 ai.mKeepScreenOn = lastKeepOn;
3383 }
3384
Philip Milnef51d91c2011-07-18 16:12:19 -07003385 onViewAdded(child);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003386
3387 if ((child.mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE) {
3388 mGroupFlags |= FLAG_NOTIFY_CHILDREN_ON_DRAWABLE_STATE_CHANGE;
3389 }
Adam Powell539ee872012-02-03 19:00:49 -08003390
3391 if (child.hasTransientState()) {
3392 childHasTransientStateChanged(child, true);
3393 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003394 }
3395
3396 private void addInArray(View child, int index) {
3397 View[] children = mChildren;
3398 final int count = mChildrenCount;
3399 final int size = children.length;
3400 if (index == count) {
3401 if (size == count) {
3402 mChildren = new View[size + ARRAY_CAPACITY_INCREMENT];
3403 System.arraycopy(children, 0, mChildren, 0, size);
3404 children = mChildren;
3405 }
3406 children[mChildrenCount++] = child;
3407 } else if (index < count) {
3408 if (size == count) {
3409 mChildren = new View[size + ARRAY_CAPACITY_INCREMENT];
3410 System.arraycopy(children, 0, mChildren, 0, index);
3411 System.arraycopy(children, index, mChildren, index + 1, count - index);
3412 children = mChildren;
3413 } else {
3414 System.arraycopy(children, index, children, index + 1, count - index);
3415 }
3416 children[index] = child;
3417 mChildrenCount++;
Joe Onorato03ab0c72011-01-06 15:46:27 -08003418 if (mLastTouchDownIndex >= index) {
3419 mLastTouchDownIndex++;
3420 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003421 } else {
3422 throw new IndexOutOfBoundsException("index=" + index + " count=" + count);
3423 }
3424 }
3425
3426 // This method also sets the child's mParent to null
3427 private void removeFromArray(int index) {
3428 final View[] children = mChildren;
Chet Haase21cd1382010-09-01 17:42:29 -07003429 if (!(mTransitioningViews != null && mTransitioningViews.contains(children[index]))) {
3430 children[index].mParent = null;
3431 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003432 final int count = mChildrenCount;
3433 if (index == count - 1) {
3434 children[--mChildrenCount] = null;
3435 } else if (index >= 0 && index < count) {
3436 System.arraycopy(children, index + 1, children, index, count - index - 1);
3437 children[--mChildrenCount] = null;
3438 } else {
3439 throw new IndexOutOfBoundsException();
3440 }
Joe Onorato03ab0c72011-01-06 15:46:27 -08003441 if (mLastTouchDownIndex == index) {
3442 mLastTouchDownTime = 0;
3443 mLastTouchDownIndex = -1;
3444 } else if (mLastTouchDownIndex > index) {
3445 mLastTouchDownIndex--;
3446 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003447 }
3448
3449 // This method also sets the children's mParent to null
3450 private void removeFromArray(int start, int count) {
3451 final View[] children = mChildren;
3452 final int childrenCount = mChildrenCount;
3453
3454 start = Math.max(0, start);
3455 final int end = Math.min(childrenCount, start + count);
3456
3457 if (start == end) {
3458 return;
3459 }
3460
3461 if (end == childrenCount) {
3462 for (int i = start; i < end; i++) {
3463 children[i].mParent = null;
3464 children[i] = null;
3465 }
3466 } else {
3467 for (int i = start; i < end; i++) {
3468 children[i].mParent = null;
3469 }
3470
3471 // Since we're looping above, we might as well do the copy, but is arraycopy()
3472 // faster than the extra 2 bounds checks we would do in the loop?
3473 System.arraycopy(children, end, children, start, childrenCount - end);
3474
3475 for (int i = childrenCount - (end - start); i < childrenCount; i++) {
3476 children[i] = null;
3477 }
3478 }
3479
3480 mChildrenCount -= (end - start);
3481 }
3482
3483 private void bindLayoutAnimation(View child) {
3484 Animation a = mLayoutAnimationController.getAnimationForView(child);
3485 child.setAnimation(a);
3486 }
3487
3488 /**
3489 * Subclasses should override this method to set layout animation
3490 * parameters on the supplied child.
3491 *
3492 * @param child the child to associate with animation parameters
3493 * @param params the child's layout parameters which hold the animation
3494 * parameters
3495 * @param index the index of the child in the view group
3496 * @param count the number of children in the view group
3497 */
3498 protected void attachLayoutAnimationParameters(View child,
3499 LayoutParams params, int index, int count) {
3500 LayoutAnimationController.AnimationParameters animationParams =
3501 params.layoutAnimationParameters;
3502 if (animationParams == null) {
3503 animationParams = new LayoutAnimationController.AnimationParameters();
3504 params.layoutAnimationParameters = animationParams;
3505 }
3506
3507 animationParams.count = count;
3508 animationParams.index = index;
3509 }
3510
3511 /**
3512 * {@inheritDoc}
Romain Guy393a52c2012-05-22 20:21:08 -07003513 *
3514 * <p><strong>Note:</strong> do not invoke this method from
3515 * {@link #draw(android.graphics.Canvas)}, {@link #onDraw(android.graphics.Canvas)},
3516 * {@link #dispatchDraw(android.graphics.Canvas)} or any related method.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003517 */
3518 public void removeView(View view) {
3519 removeViewInternal(view);
3520 requestLayout();
Romain Guy849d0a32011-02-01 17:20:48 -08003521 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003522 }
3523
3524 /**
3525 * Removes a view during layout. This is useful if in your onLayout() method,
3526 * you need to remove more views.
3527 *
Romain Guy393a52c2012-05-22 20:21:08 -07003528 * <p><strong>Note:</strong> do not invoke this method from
3529 * {@link #draw(android.graphics.Canvas)}, {@link #onDraw(android.graphics.Canvas)},
3530 * {@link #dispatchDraw(android.graphics.Canvas)} or any related method.</p>
3531 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003532 * @param view the view to remove from the group
3533 */
3534 public void removeViewInLayout(View view) {
3535 removeViewInternal(view);
3536 }
3537
3538 /**
3539 * Removes a range of views during layout. This is useful if in your onLayout() method,
3540 * you need to remove more views.
3541 *
Romain Guy393a52c2012-05-22 20:21:08 -07003542 * <p><strong>Note:</strong> do not invoke this method from
3543 * {@link #draw(android.graphics.Canvas)}, {@link #onDraw(android.graphics.Canvas)},
3544 * {@link #dispatchDraw(android.graphics.Canvas)} or any related method.</p>
3545 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003546 * @param start the index of the first view to remove from the group
3547 * @param count the number of views to remove from the group
3548 */
3549 public void removeViewsInLayout(int start, int count) {
3550 removeViewsInternal(start, count);
3551 }
3552
3553 /**
3554 * Removes the view at the specified position in the group.
3555 *
Romain Guy393a52c2012-05-22 20:21:08 -07003556 * <p><strong>Note:</strong> do not invoke this method from
3557 * {@link #draw(android.graphics.Canvas)}, {@link #onDraw(android.graphics.Canvas)},
3558 * {@link #dispatchDraw(android.graphics.Canvas)} or any related method.</p>
3559 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003560 * @param index the position in the group of the view to remove
3561 */
3562 public void removeViewAt(int index) {
3563 removeViewInternal(index, getChildAt(index));
3564 requestLayout();
Romain Guy849d0a32011-02-01 17:20:48 -08003565 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003566 }
3567
3568 /**
3569 * Removes the specified range of views from the group.
3570 *
Romain Guy393a52c2012-05-22 20:21:08 -07003571 * <p><strong>Note:</strong> do not invoke this method from
3572 * {@link #draw(android.graphics.Canvas)}, {@link #onDraw(android.graphics.Canvas)},
3573 * {@link #dispatchDraw(android.graphics.Canvas)} or any related method.</p>
3574 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003575 * @param start the first position in the group of the range of views to remove
3576 * @param count the number of views to remove
3577 */
3578 public void removeViews(int start, int count) {
3579 removeViewsInternal(start, count);
3580 requestLayout();
Romain Guy849d0a32011-02-01 17:20:48 -08003581 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003582 }
3583
3584 private void removeViewInternal(View view) {
3585 final int index = indexOfChild(view);
3586 if (index >= 0) {
3587 removeViewInternal(index, view);
3588 }
3589 }
3590
3591 private void removeViewInternal(int index, View view) {
Chet Haase21cd1382010-09-01 17:42:29 -07003592
3593 if (mTransition != null) {
Chet Haase5e25c2c2010-09-16 11:15:56 -07003594 mTransition.removeChild(this, view);
Chet Haase21cd1382010-09-01 17:42:29 -07003595 }
3596
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003597 boolean clearChildFocus = false;
3598 if (view == mFocused) {
Svetoslav Ganov57cadf22012-04-04 16:44:39 -07003599 view.unFocus();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003600 clearChildFocus = true;
3601 }
3602
Svetoslav Ganov961bf0e2012-05-08 09:40:03 -07003603 view.clearAccessibilityFocus();
3604
Jeff Brown59a422e2012-04-19 15:19:19 -07003605 cancelTouchTarget(view);
3606 cancelHoverTarget(view);
3607
Chet Haase21cd1382010-09-01 17:42:29 -07003608 if (view.getAnimation() != null ||
3609 (mTransitioningViews != null && mTransitioningViews.contains(view))) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003610 addDisappearingView(view);
3611 } else if (view.mAttachInfo != null) {
3612 view.dispatchDetachedFromWindow();
3613 }
3614
Adam Powell539ee872012-02-03 19:00:49 -08003615 if (view.hasTransientState()) {
3616 childHasTransientStateChanged(view, false);
3617 }
3618
Fabrice Di Meglio1f88ba82012-09-24 14:56:49 -07003619 view.resetRtlProperties();
Fabrice Di Meglio23c89fd2012-08-13 12:17:42 -07003620
Philip Milnef51d91c2011-07-18 16:12:19 -07003621 onViewRemoved(view);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003622
3623 needGlobalAttributesUpdate(false);
Romain Guy8506ab42009-06-11 17:35:47 -07003624
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003625 removeFromArray(index);
3626
3627 if (clearChildFocus) {
3628 clearChildFocus(view);
Svetoslav Ganov57cadf22012-04-04 16:44:39 -07003629 ensureInputFocusOnFirstFocusable();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003630 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07003631
3632 if (view.isAccessibilityFocused()) {
3633 view.clearAccessibilityFocus();
3634 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003635 }
3636
Chet Haase21cd1382010-09-01 17:42:29 -07003637 /**
3638 * Sets the LayoutTransition object for this ViewGroup. If the LayoutTransition object is
3639 * not null, changes in layout which occur because of children being added to or removed from
3640 * the ViewGroup will be animated according to the animations defined in that LayoutTransition
3641 * object. By default, the transition object is null (so layout changes are not animated).
3642 *
3643 * @param transition The LayoutTransition object that will animated changes in layout. A value
3644 * of <code>null</code> means no transition will run on layout changes.
Chet Haase13cc1202010-09-03 15:39:20 -07003645 * @attr ref android.R.styleable#ViewGroup_animateLayoutChanges
Chet Haase21cd1382010-09-01 17:42:29 -07003646 */
3647 public void setLayoutTransition(LayoutTransition transition) {
Chet Haaseb20db3e2010-09-10 13:07:30 -07003648 if (mTransition != null) {
3649 mTransition.removeTransitionListener(mLayoutTransitionListener);
3650 }
Chet Haase21cd1382010-09-01 17:42:29 -07003651 mTransition = transition;
Chet Haase13cc1202010-09-03 15:39:20 -07003652 if (mTransition != null) {
3653 mTransition.addTransitionListener(mLayoutTransitionListener);
3654 }
3655 }
3656
3657 /**
3658 * Gets the LayoutTransition object for this ViewGroup. If the LayoutTransition object is
3659 * not null, changes in layout which occur because of children being added to or removed from
3660 * the ViewGroup will be animated according to the animations defined in that LayoutTransition
3661 * object. By default, the transition object is null (so layout changes are not animated).
3662 *
3663 * @return LayoutTranstion The LayoutTransition object that will animated changes in layout.
3664 * A value of <code>null</code> means no transition will run on layout changes.
3665 */
3666 public LayoutTransition getLayoutTransition() {
3667 return mTransition;
Chet Haase21cd1382010-09-01 17:42:29 -07003668 }
3669
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003670 private void removeViewsInternal(int start, int count) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003671 final View focused = mFocused;
3672 final boolean detach = mAttachInfo != null;
3673 View clearChildFocus = null;
3674
3675 final View[] children = mChildren;
3676 final int end = start + count;
3677
3678 for (int i = start; i < end; i++) {
3679 final View view = children[i];
3680
Chet Haase21cd1382010-09-01 17:42:29 -07003681 if (mTransition != null) {
Chet Haase5e25c2c2010-09-16 11:15:56 -07003682 mTransition.removeChild(this, view);
Chet Haase21cd1382010-09-01 17:42:29 -07003683 }
3684
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003685 if (view == focused) {
Svetoslav Ganov57cadf22012-04-04 16:44:39 -07003686 view.unFocus();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003687 clearChildFocus = view;
3688 }
3689
Svetoslav Ganov961bf0e2012-05-08 09:40:03 -07003690 view.clearAccessibilityFocus();
3691
Jeff Brown59a422e2012-04-19 15:19:19 -07003692 cancelTouchTarget(view);
3693 cancelHoverTarget(view);
3694
Chet Haase21cd1382010-09-01 17:42:29 -07003695 if (view.getAnimation() != null ||
3696 (mTransitioningViews != null && mTransitioningViews.contains(view))) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003697 addDisappearingView(view);
3698 } else if (detach) {
3699 view.dispatchDetachedFromWindow();
3700 }
3701
Adam Powell539ee872012-02-03 19:00:49 -08003702 if (view.hasTransientState()) {
3703 childHasTransientStateChanged(view, false);
3704 }
3705
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003706 needGlobalAttributesUpdate(false);
Romain Guy8506ab42009-06-11 17:35:47 -07003707
Philip Milnef51d91c2011-07-18 16:12:19 -07003708 onViewRemoved(view);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003709 }
3710
3711 removeFromArray(start, count);
3712
3713 if (clearChildFocus != null) {
3714 clearChildFocus(clearChildFocus);
Svetoslav Ganov57cadf22012-04-04 16:44:39 -07003715 ensureInputFocusOnFirstFocusable();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003716 }
3717 }
3718
3719 /**
3720 * Call this method to remove all child views from the
3721 * ViewGroup.
Romain Guy393a52c2012-05-22 20:21:08 -07003722 *
3723 * <p><strong>Note:</strong> do not invoke this method from
3724 * {@link #draw(android.graphics.Canvas)}, {@link #onDraw(android.graphics.Canvas)},
3725 * {@link #dispatchDraw(android.graphics.Canvas)} or any related method.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003726 */
3727 public void removeAllViews() {
3728 removeAllViewsInLayout();
3729 requestLayout();
Romain Guy849d0a32011-02-01 17:20:48 -08003730 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003731 }
3732
3733 /**
3734 * Called by a ViewGroup subclass to remove child views from itself,
3735 * when it must first know its size on screen before it can calculate how many
3736 * child views it will render. An example is a Gallery or a ListView, which
3737 * may "have" 50 children, but actually only render the number of children
3738 * that can currently fit inside the object on screen. Do not call
3739 * this method unless you are extending ViewGroup and understand the
3740 * view measuring and layout pipeline.
Romain Guy393a52c2012-05-22 20:21:08 -07003741 *
3742 * <p><strong>Note:</strong> do not invoke this method from
3743 * {@link #draw(android.graphics.Canvas)}, {@link #onDraw(android.graphics.Canvas)},
3744 * {@link #dispatchDraw(android.graphics.Canvas)} or any related method.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003745 */
3746 public void removeAllViewsInLayout() {
3747 final int count = mChildrenCount;
3748 if (count <= 0) {
3749 return;
3750 }
3751
3752 final View[] children = mChildren;
3753 mChildrenCount = 0;
3754
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003755 final View focused = mFocused;
3756 final boolean detach = mAttachInfo != null;
3757 View clearChildFocus = null;
3758
3759 needGlobalAttributesUpdate(false);
Romain Guy8506ab42009-06-11 17:35:47 -07003760
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003761 for (int i = count - 1; i >= 0; i--) {
3762 final View view = children[i];
3763
Chet Haase21cd1382010-09-01 17:42:29 -07003764 if (mTransition != null) {
Chet Haase5e25c2c2010-09-16 11:15:56 -07003765 mTransition.removeChild(this, view);
Chet Haase21cd1382010-09-01 17:42:29 -07003766 }
3767
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003768 if (view == focused) {
Svetoslav Ganov57cadf22012-04-04 16:44:39 -07003769 view.unFocus();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003770 clearChildFocus = view;
3771 }
3772
Svetoslav Ganov961bf0e2012-05-08 09:40:03 -07003773 view.clearAccessibilityFocus();
3774
Jeff Brown59a422e2012-04-19 15:19:19 -07003775 cancelTouchTarget(view);
3776 cancelHoverTarget(view);
3777
Chet Haase21cd1382010-09-01 17:42:29 -07003778 if (view.getAnimation() != null ||
3779 (mTransitioningViews != null && mTransitioningViews.contains(view))) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003780 addDisappearingView(view);
3781 } else if (detach) {
3782 view.dispatchDetachedFromWindow();
3783 }
3784
Adam Powell539ee872012-02-03 19:00:49 -08003785 if (view.hasTransientState()) {
3786 childHasTransientStateChanged(view, false);
3787 }
3788
Philip Milnef51d91c2011-07-18 16:12:19 -07003789 onViewRemoved(view);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003790
3791 view.mParent = null;
3792 children[i] = null;
3793 }
3794
3795 if (clearChildFocus != null) {
3796 clearChildFocus(clearChildFocus);
Svetoslav Ganov57cadf22012-04-04 16:44:39 -07003797 ensureInputFocusOnFirstFocusable();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003798 }
3799 }
3800
3801 /**
3802 * Finishes the removal of a detached view. This method will dispatch the detached from
3803 * window event and notify the hierarchy change listener.
Chet Haaseca479d42012-08-30 17:20:08 -07003804 * <p>
3805 * This method is intended to be lightweight and makes no assumptions about whether the
3806 * parent or child should be redrawn. Proper use of this method will include also making
3807 * any appropriate {@link #requestLayout()} or {@link #invalidate()} calls.
3808 * For example, callers can {@link #post(Runnable) post} a {@link Runnable}
3809 * which performs a {@link #requestLayout()} on the next frame, after all detach/remove
3810 * calls are finished, causing layout to be run prior to redrawing the view hierarchy.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003811 *
3812 * @param child the child to be definitely removed from the view hierarchy
3813 * @param animate if true and the view has an animation, the view is placed in the
3814 * disappearing views list, otherwise, it is detached from the window
3815 *
3816 * @see #attachViewToParent(View, int, android.view.ViewGroup.LayoutParams)
3817 * @see #detachAllViewsFromParent()
3818 * @see #detachViewFromParent(View)
3819 * @see #detachViewFromParent(int)
3820 */
3821 protected void removeDetachedView(View child, boolean animate) {
Chet Haase21cd1382010-09-01 17:42:29 -07003822 if (mTransition != null) {
Chet Haase5e25c2c2010-09-16 11:15:56 -07003823 mTransition.removeChild(this, child);
Chet Haase21cd1382010-09-01 17:42:29 -07003824 }
3825
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003826 if (child == mFocused) {
3827 child.clearFocus();
3828 }
Romain Guy8506ab42009-06-11 17:35:47 -07003829
Svetoslav Ganov961bf0e2012-05-08 09:40:03 -07003830 child.clearAccessibilityFocus();
3831
Jeff Brown59a422e2012-04-19 15:19:19 -07003832 cancelTouchTarget(child);
3833 cancelHoverTarget(child);
3834
Chet Haase21cd1382010-09-01 17:42:29 -07003835 if ((animate && child.getAnimation() != null) ||
3836 (mTransitioningViews != null && mTransitioningViews.contains(child))) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003837 addDisappearingView(child);
3838 } else if (child.mAttachInfo != null) {
3839 child.dispatchDetachedFromWindow();
3840 }
3841
Adam Powell539ee872012-02-03 19:00:49 -08003842 if (child.hasTransientState()) {
3843 childHasTransientStateChanged(child, false);
3844 }
3845
Philip Milnef51d91c2011-07-18 16:12:19 -07003846 onViewRemoved(child);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003847 }
3848
3849 /**
3850 * Attaches a view to this view group. Attaching a view assigns this group as the parent,
Chet Haaseca479d42012-08-30 17:20:08 -07003851 * sets the layout parameters and puts the view in the list of children so that
3852 * it can be retrieved by calling {@link #getChildAt(int)}.
3853 * <p>
3854 * This method is intended to be lightweight and makes no assumptions about whether the
3855 * parent or child should be redrawn. Proper use of this method will include also making
3856 * any appropriate {@link #requestLayout()} or {@link #invalidate()} calls.
3857 * For example, callers can {@link #post(Runnable) post} a {@link Runnable}
3858 * which performs a {@link #requestLayout()} on the next frame, after all detach/attach
3859 * calls are finished, causing layout to be run prior to redrawing the view hierarchy.
3860 * <p>
3861 * This method should be called only for views which were detached from their parent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003862 *
3863 * @param child the child to attach
3864 * @param index the index at which the child should be attached
3865 * @param params the layout parameters of the child
3866 *
3867 * @see #removeDetachedView(View, boolean)
3868 * @see #detachAllViewsFromParent()
3869 * @see #detachViewFromParent(View)
3870 * @see #detachViewFromParent(int)
3871 */
3872 protected void attachViewToParent(View child, int index, LayoutParams params) {
3873 child.mLayoutParams = params;
3874
3875 if (index < 0) {
3876 index = mChildrenCount;
3877 }
3878
3879 addInArray(child, index);
3880
3881 child.mParent = this;
Dianne Hackborn4702a852012-08-17 15:18:29 -07003882 child.mPrivateFlags = (child.mPrivateFlags & ~PFLAG_DIRTY_MASK
3883 & ~PFLAG_DRAWING_CACHE_VALID)
3884 | PFLAG_DRAWN | PFLAG_INVALIDATED;
3885 this.mPrivateFlags |= PFLAG_INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003886
3887 if (child.hasFocus()) {
3888 requestChildFocus(child, child.findFocus());
3889 }
3890 }
3891
3892 /**
Chet Haaseca479d42012-08-30 17:20:08 -07003893 * Detaches a view from its parent. Detaching a view should be followed
3894 * either by a call to
3895 * {@link #attachViewToParent(View, int, android.view.ViewGroup.LayoutParams)}
3896 * or a call to {@link #removeDetachedView(View, boolean)}. Detachment should only be
3897 * temporary; reattachment or removal should happen within the same drawing cycle as
3898 * detachment. When a view is detached, its parent is null and cannot be retrieved by a
3899 * call to {@link #getChildAt(int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003900 *
3901 * @param child the child to detach
3902 *
3903 * @see #detachViewFromParent(int)
3904 * @see #detachViewsFromParent(int, int)
3905 * @see #detachAllViewsFromParent()
3906 * @see #attachViewToParent(View, int, android.view.ViewGroup.LayoutParams)
3907 * @see #removeDetachedView(View, boolean)
3908 */
3909 protected void detachViewFromParent(View child) {
3910 removeFromArray(indexOfChild(child));
3911 }
3912
3913 /**
Chet Haaseca479d42012-08-30 17:20:08 -07003914 * Detaches a view from its parent. Detaching a view should be followed
3915 * either by a call to
3916 * {@link #attachViewToParent(View, int, android.view.ViewGroup.LayoutParams)}
3917 * or a call to {@link #removeDetachedView(View, boolean)}. Detachment should only be
3918 * temporary; reattachment or removal should happen within the same drawing cycle as
3919 * detachment. When a view is detached, its parent is null and cannot be retrieved by a
3920 * call to {@link #getChildAt(int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003921 *
3922 * @param index the index of the child to detach
3923 *
3924 * @see #detachViewFromParent(View)
3925 * @see #detachAllViewsFromParent()
3926 * @see #detachViewsFromParent(int, int)
3927 * @see #attachViewToParent(View, int, android.view.ViewGroup.LayoutParams)
3928 * @see #removeDetachedView(View, boolean)
3929 */
3930 protected void detachViewFromParent(int index) {
3931 removeFromArray(index);
3932 }
3933
3934 /**
Chet Haaseca479d42012-08-30 17:20:08 -07003935 * Detaches a range of views from their parents. Detaching a view should be followed
3936 * either by a call to
3937 * {@link #attachViewToParent(View, int, android.view.ViewGroup.LayoutParams)}
3938 * or a call to {@link #removeDetachedView(View, boolean)}. Detachment should only be
3939 * temporary; reattachment or removal should happen within the same drawing cycle as
3940 * detachment. When a view is detached, its parent is null and cannot be retrieved by a
3941 * call to {@link #getChildAt(int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003942 *
3943 * @param start the first index of the childrend range to detach
3944 * @param count the number of children to detach
3945 *
3946 * @see #detachViewFromParent(View)
3947 * @see #detachViewFromParent(int)
3948 * @see #detachAllViewsFromParent()
3949 * @see #attachViewToParent(View, int, android.view.ViewGroup.LayoutParams)
3950 * @see #removeDetachedView(View, boolean)
3951 */
3952 protected void detachViewsFromParent(int start, int count) {
3953 removeFromArray(start, count);
3954 }
3955
3956 /**
Chet Haaseca479d42012-08-30 17:20:08 -07003957 * Detaches all views from the parent. Detaching a view should be followed
3958 * either by a call to
3959 * {@link #attachViewToParent(View, int, android.view.ViewGroup.LayoutParams)}
3960 * or a call to {@link #removeDetachedView(View, boolean)}. Detachment should only be
3961 * temporary; reattachment or removal should happen within the same drawing cycle as
3962 * detachment. When a view is detached, its parent is null and cannot be retrieved by a
3963 * call to {@link #getChildAt(int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003964 *
3965 * @see #detachViewFromParent(View)
3966 * @see #detachViewFromParent(int)
3967 * @see #detachViewsFromParent(int, int)
3968 * @see #attachViewToParent(View, int, android.view.ViewGroup.LayoutParams)
3969 * @see #removeDetachedView(View, boolean)
3970 */
3971 protected void detachAllViewsFromParent() {
3972 final int count = mChildrenCount;
3973 if (count <= 0) {
3974 return;
3975 }
3976
3977 final View[] children = mChildren;
3978 mChildrenCount = 0;
3979
3980 for (int i = count - 1; i >= 0; i--) {
3981 children[i].mParent = null;
3982 children[i] = null;
3983 }
3984 }
3985
3986 /**
3987 * Don't call or override this method. It is used for the implementation of
3988 * the view hierarchy.
3989 */
3990 public final void invalidateChild(View child, final Rect dirty) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003991 ViewParent parent = this;
3992
3993 final AttachInfo attachInfo = mAttachInfo;
3994 if (attachInfo != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003995 // If the child is drawing an animation, we want to copy this flag onto
3996 // ourselves and the parent to make sure the invalidate request goes
3997 // through
Dianne Hackborn4702a852012-08-17 15:18:29 -07003998 final boolean drawAnimation = (child.mPrivateFlags & PFLAG_DRAW_ANIMATION)
3999 == PFLAG_DRAW_ANIMATION;
Romain Guy24443ea2009-05-11 11:56:30 -07004000
Romain Guyfe455af2012-02-15 16:40:20 -08004001 // Check whether the child that requests the invalidate is fully opaque
4002 // Views being animated or transformed are not considered opaque because we may
4003 // be invalidating their old position and need the parent to paint behind them.
4004 Matrix childMatrix = child.getMatrix();
4005 final boolean isOpaque = child.isOpaque() && !drawAnimation &&
4006 child.getAnimation() == null && childMatrix.isIdentity();
4007 // Mark the child as dirty, using the appropriate flag
4008 // Make sure we do not set both flags at the same time
Dianne Hackborn4702a852012-08-17 15:18:29 -07004009 int opaqueFlag = isOpaque ? PFLAG_DIRTY_OPAQUE : PFLAG_DIRTY;
Romain Guyfe455af2012-02-15 16:40:20 -08004010
4011 if (child.mLayerType != LAYER_TYPE_NONE) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07004012 mPrivateFlags |= PFLAG_INVALIDATED;
4013 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID;
Romain Guyfe455af2012-02-15 16:40:20 -08004014 child.mLocalDirtyRect.union(dirty);
4015 }
4016
4017 final int[] location = attachInfo.mInvalidateChildLocation;
4018 location[CHILD_LEFT_INDEX] = child.mLeft;
4019 location[CHILD_TOP_INDEX] = child.mTop;
Chet Haase599913d2012-07-23 16:22:05 -07004020 if (!childMatrix.isIdentity() ||
4021 (mGroupFlags & ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) {
Romain Guyfe455af2012-02-15 16:40:20 -08004022 RectF boundingRect = attachInfo.mTmpTransformRect;
4023 boundingRect.set(dirty);
Chet Haase599913d2012-07-23 16:22:05 -07004024 Matrix transformMatrix;
4025 if ((mGroupFlags & ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) {
4026 Transformation t = attachInfo.mTmpTransformation;
4027 boolean transformed = getChildStaticTransformation(child, t);
4028 if (transformed) {
4029 transformMatrix = attachInfo.mTmpMatrix;
4030 transformMatrix.set(t.getMatrix());
4031 if (!childMatrix.isIdentity()) {
4032 transformMatrix.preConcat(childMatrix);
4033 }
4034 } else {
4035 transformMatrix = childMatrix;
4036 }
4037 } else {
4038 transformMatrix = childMatrix;
4039 }
4040 transformMatrix.mapRect(boundingRect);
Romain Guyfe455af2012-02-15 16:40:20 -08004041 dirty.set((int) (boundingRect.left - 0.5f),
4042 (int) (boundingRect.top - 0.5f),
4043 (int) (boundingRect.right + 0.5f),
4044 (int) (boundingRect.bottom + 0.5f));
4045 }
4046
4047 do {
4048 View view = null;
4049 if (parent instanceof View) {
4050 view = (View) parent;
Romain Guyfe455af2012-02-15 16:40:20 -08004051 }
4052
4053 if (drawAnimation) {
4054 if (view != null) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07004055 view.mPrivateFlags |= PFLAG_DRAW_ANIMATION;
Romain Guyfe455af2012-02-15 16:40:20 -08004056 } else if (parent instanceof ViewRootImpl) {
4057 ((ViewRootImpl) parent).mIsAnimating = true;
4058 }
4059 }
4060
4061 // If the parent is dirty opaque or not dirty, mark it dirty with the opaque
4062 // flag coming from the child that initiated the invalidate
4063 if (view != null) {
4064 if ((view.mViewFlags & FADING_EDGE_MASK) != 0 &&
4065 view.getSolidColor() == 0) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07004066 opaqueFlag = PFLAG_DIRTY;
Romain Guyfe455af2012-02-15 16:40:20 -08004067 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07004068 if ((view.mPrivateFlags & PFLAG_DIRTY_MASK) != PFLAG_DIRTY) {
4069 view.mPrivateFlags = (view.mPrivateFlags & ~PFLAG_DIRTY_MASK) | opaqueFlag;
Romain Guyfe455af2012-02-15 16:40:20 -08004070 }
4071 }
4072
4073 parent = parent.invalidateChildInParent(location, dirty);
4074 if (view != null) {
4075 // Account for transform on current parent
4076 Matrix m = view.getMatrix();
4077 if (!m.isIdentity()) {
4078 RectF boundingRect = attachInfo.mTmpTransformRect;
4079 boundingRect.set(dirty);
4080 m.mapRect(boundingRect);
Romain Guye8585b12012-02-17 18:28:47 -08004081 dirty.set((int) (boundingRect.left - 0.5f),
4082 (int) (boundingRect.top - 0.5f),
Romain Guyfe455af2012-02-15 16:40:20 -08004083 (int) (boundingRect.right + 0.5f),
4084 (int) (boundingRect.bottom + 0.5f));
4085 }
4086 }
4087 } while (parent != null);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004088 }
4089 }
4090
4091 /**
4092 * Don't call or override this method. It is used for the implementation of
4093 * the view hierarchy.
4094 *
4095 * This implementation returns null if this ViewGroup does not have a parent,
4096 * if this ViewGroup is already fully invalidated or if the dirty rectangle
4097 * does not intersect with this ViewGroup's bounds.
4098 */
4099 public ViewParent invalidateChildInParent(final int[] location, final Rect dirty) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07004100 if ((mPrivateFlags & PFLAG_DRAWN) == PFLAG_DRAWN ||
4101 (mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == PFLAG_DRAWING_CACHE_VALID) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004102 if ((mGroupFlags & (FLAG_OPTIMIZE_INVALIDATE | FLAG_ANIMATION_DONE)) !=
4103 FLAG_OPTIMIZE_INVALIDATE) {
4104 dirty.offset(location[CHILD_LEFT_INDEX] - mScrollX,
4105 location[CHILD_TOP_INDEX] - mScrollY);
4106
4107 final int left = mLeft;
4108 final int top = mTop;
4109
Chet Haase05e91ed2012-07-03 14:17:57 -07004110 if ((mGroupFlags & FLAG_CLIP_CHILDREN) == FLAG_CLIP_CHILDREN) {
4111 if (!dirty.intersect(0, 0, mRight - left, mBottom - top)) {
4112 dirty.setEmpty();
Romain Guy3a3133d2011-02-01 22:59:58 -08004113 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004114 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07004115 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID;
Chet Haase05e91ed2012-07-03 14:17:57 -07004116
4117 location[CHILD_LEFT_INDEX] = left;
4118 location[CHILD_TOP_INDEX] = top;
4119
4120 if (mLayerType != LAYER_TYPE_NONE) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07004121 mPrivateFlags |= PFLAG_INVALIDATED;
Chet Haase05e91ed2012-07-03 14:17:57 -07004122 mLocalDirtyRect.union(dirty);
4123 }
4124
4125 return mParent;
4126
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004127 } else {
Dianne Hackborn4702a852012-08-17 15:18:29 -07004128 mPrivateFlags &= ~PFLAG_DRAWN & ~PFLAG_DRAWING_CACHE_VALID;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004129
4130 location[CHILD_LEFT_INDEX] = mLeft;
4131 location[CHILD_TOP_INDEX] = mTop;
Chet Haasea3db8662011-07-19 10:36:05 -07004132 if ((mGroupFlags & FLAG_CLIP_CHILDREN) == FLAG_CLIP_CHILDREN) {
4133 dirty.set(0, 0, mRight - mLeft, mBottom - mTop);
4134 } else {
4135 // in case the dirty rect extends outside the bounds of this container
4136 dirty.union(0, 0, mRight - mLeft, mBottom - mTop);
4137 }
Romain Guy3a3133d2011-02-01 22:59:58 -08004138
4139 if (mLayerType != LAYER_TYPE_NONE) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07004140 mPrivateFlags |= PFLAG_INVALIDATED;
Romain Guy3a3133d2011-02-01 22:59:58 -08004141 mLocalDirtyRect.union(dirty);
4142 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004143
4144 return mParent;
4145 }
4146 }
4147
4148 return null;
4149 }
4150
4151 /**
Chet Haase9d1992d2012-03-13 11:03:25 -07004152 * Quick invalidation method called by View.invalidateViewProperty. This doesn't set the
4153 * DRAWN flags and doesn't handle the Animation logic that the default invalidation methods
4154 * do; all we want to do here is schedule a traversal with the appropriate dirty rect.
4155 *
4156 * @hide
4157 */
4158 public void invalidateChildFast(View child, final Rect dirty) {
4159 ViewParent parent = this;
4160
4161 final AttachInfo attachInfo = mAttachInfo;
4162 if (attachInfo != null) {
4163 if (child.mLayerType != LAYER_TYPE_NONE) {
4164 child.mLocalDirtyRect.union(dirty);
4165 }
4166
4167 int left = child.mLeft;
4168 int top = child.mTop;
4169 if (!child.getMatrix().isIdentity()) {
4170 child.transformRect(dirty);
4171 }
4172
4173 do {
4174 if (parent instanceof ViewGroup) {
4175 ViewGroup parentVG = (ViewGroup) parent;
Chet Haaseb85967b2012-03-26 14:37:51 -07004176 if (parentVG.mLayerType != LAYER_TYPE_NONE) {
4177 // Layered parents should be recreated, not just re-issued
4178 parentVG.invalidate();
4179 parent = null;
4180 } else {
4181 parent = parentVG.invalidateChildInParentFast(left, top, dirty);
4182 left = parentVG.mLeft;
4183 top = parentVG.mTop;
4184 }
Chet Haase9d1992d2012-03-13 11:03:25 -07004185 } else {
4186 // Reached the top; this calls into the usual invalidate method in
4187 // ViewRootImpl, which schedules a traversal
4188 final int[] location = attachInfo.mInvalidateChildLocation;
4189 location[0] = left;
4190 location[1] = top;
4191 parent = parent.invalidateChildInParent(location, dirty);
4192 }
4193 } while (parent != null);
4194 }
4195 }
4196
4197 /**
4198 * Quick invalidation method that simply transforms the dirty rect into the parent's
4199 * coordinate system, pruning the invalidation if the parent has already been invalidated.
4200 */
4201 private ViewParent invalidateChildInParentFast(int left, int top, final Rect dirty) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07004202 if ((mPrivateFlags & PFLAG_DRAWN) == PFLAG_DRAWN ||
4203 (mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == PFLAG_DRAWING_CACHE_VALID) {
Chet Haase9d1992d2012-03-13 11:03:25 -07004204 dirty.offset(left - mScrollX, top - mScrollY);
4205
4206 if ((mGroupFlags & FLAG_CLIP_CHILDREN) == 0 ||
4207 dirty.intersect(0, 0, mRight - mLeft, mBottom - mTop)) {
4208
4209 if (mLayerType != LAYER_TYPE_NONE) {
4210 mLocalDirtyRect.union(dirty);
4211 }
4212 if (!getMatrix().isIdentity()) {
4213 transformRect(dirty);
4214 }
4215
4216 return mParent;
4217 }
4218 }
4219
4220 return null;
4221 }
4222
4223 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004224 * Offset a rectangle that is in a descendant's coordinate
4225 * space into our coordinate space.
4226 * @param descendant A descendant of this view
4227 * @param rect A rectangle defined in descendant's coordinate space.
4228 */
4229 public final void offsetDescendantRectToMyCoords(View descendant, Rect rect) {
4230 offsetRectBetweenParentAndChild(descendant, rect, true, false);
4231 }
4232
4233 /**
4234 * Offset a rectangle that is in our coordinate space into an ancestor's
4235 * coordinate space.
4236 * @param descendant A descendant of this view
4237 * @param rect A rectangle defined in descendant's coordinate space.
4238 */
4239 public final void offsetRectIntoDescendantCoords(View descendant, Rect rect) {
4240 offsetRectBetweenParentAndChild(descendant, rect, false, false);
4241 }
4242
4243 /**
4244 * Helper method that offsets a rect either from parent to descendant or
4245 * descendant to parent.
4246 */
4247 void offsetRectBetweenParentAndChild(View descendant, Rect rect,
4248 boolean offsetFromChildToParent, boolean clipToBounds) {
4249
4250 // already in the same coord system :)
4251 if (descendant == this) {
4252 return;
4253 }
4254
4255 ViewParent theParent = descendant.mParent;
4256
4257 // search and offset up to the parent
4258 while ((theParent != null)
4259 && (theParent instanceof View)
4260 && (theParent != this)) {
4261
4262 if (offsetFromChildToParent) {
4263 rect.offset(descendant.mLeft - descendant.mScrollX,
4264 descendant.mTop - descendant.mScrollY);
4265 if (clipToBounds) {
4266 View p = (View) theParent;
4267 rect.intersect(0, 0, p.mRight - p.mLeft, p.mBottom - p.mTop);
4268 }
4269 } else {
4270 if (clipToBounds) {
4271 View p = (View) theParent;
4272 rect.intersect(0, 0, p.mRight - p.mLeft, p.mBottom - p.mTop);
4273 }
4274 rect.offset(descendant.mScrollX - descendant.mLeft,
4275 descendant.mScrollY - descendant.mTop);
4276 }
4277
4278 descendant = (View) theParent;
4279 theParent = descendant.mParent;
4280 }
4281
4282 // now that we are up to this view, need to offset one more time
4283 // to get into our coordinate space
4284 if (theParent == this) {
4285 if (offsetFromChildToParent) {
4286 rect.offset(descendant.mLeft - descendant.mScrollX,
4287 descendant.mTop - descendant.mScrollY);
4288 } else {
4289 rect.offset(descendant.mScrollX - descendant.mLeft,
4290 descendant.mScrollY - descendant.mTop);
4291 }
4292 } else {
4293 throw new IllegalArgumentException("parameter must be a descendant of this view");
4294 }
4295 }
4296
4297 /**
4298 * Offset the vertical location of all children of this view by the specified number of pixels.
4299 *
4300 * @param offset the number of pixels to offset
4301 *
4302 * @hide
4303 */
4304 public void offsetChildrenTopAndBottom(int offset) {
4305 final int count = mChildrenCount;
4306 final View[] children = mChildren;
4307
4308 for (int i = 0; i < count; i++) {
4309 final View v = children[i];
4310 v.mTop += offset;
4311 v.mBottom += offset;
Chet Haase1271e2c2012-04-20 09:54:27 -07004312 if (v.mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08004313 v.mDisplayList.offsetTopBottom(offset);
Chet Haase9d1992d2012-03-13 11:03:25 -07004314 invalidateViewProperty(false, false);
Chet Haasea1cff502012-02-21 13:43:44 -08004315 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004316 }
4317 }
4318
4319 /**
4320 * {@inheritDoc}
4321 */
4322 public boolean getChildVisibleRect(View child, Rect r, android.graphics.Point offset) {
Adam Powellf93bb6d2011-12-12 15:21:57 -08004323 // It doesn't make a whole lot of sense to call this on a view that isn't attached,
4324 // but for some simple tests it can be useful. If we don't have attach info this
4325 // will allocate memory.
4326 final RectF rect = mAttachInfo != null ? mAttachInfo.mTmpTransformRect : new RectF();
Gilles Debunnecea45132011-11-24 02:19:27 +01004327 rect.set(r);
4328
4329 if (!child.hasIdentityMatrix()) {
4330 child.getMatrix().mapRect(rect);
4331 }
4332
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004333 int dx = child.mLeft - mScrollX;
4334 int dy = child.mTop - mScrollY;
Gilles Debunnecea45132011-11-24 02:19:27 +01004335
4336 rect.offset(dx, dy);
4337
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004338 if (offset != null) {
Gilles Debunnecea45132011-11-24 02:19:27 +01004339 if (!child.hasIdentityMatrix()) {
Adam Powellf93bb6d2011-12-12 15:21:57 -08004340 float[] position = mAttachInfo != null ? mAttachInfo.mTmpTransformLocation
4341 : new float[2];
Gilles Debunnecea45132011-11-24 02:19:27 +01004342 position[0] = offset.x;
4343 position[1] = offset.y;
4344 child.getMatrix().mapPoints(position);
4345 offset.x = (int) (position[0] + 0.5f);
4346 offset.y = (int) (position[1] + 0.5f);
4347 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004348 offset.x += dx;
4349 offset.y += dy;
4350 }
Gilles Debunnecea45132011-11-24 02:19:27 +01004351
4352 if (rect.intersect(0, 0, mRight - mLeft, mBottom - mTop)) {
4353 if (mParent == null) return true;
4354 r.set((int) (rect.left + 0.5f), (int) (rect.top + 0.5f),
4355 (int) (rect.right + 0.5f), (int) (rect.bottom + 0.5f));
4356 return mParent.getChildVisibleRect(this, r, offset);
4357 }
4358
4359 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004360 }
4361
4362 /**
4363 * {@inheritDoc}
4364 */
4365 @Override
Chet Haase9c087442011-01-12 16:20:16 -08004366 public final void layout(int l, int t, int r, int b) {
4367 if (mTransition == null || !mTransition.isChangingLayout()) {
Chet Haase7dd4a532012-04-16 13:35:09 -07004368 if (mTransition != null) {
4369 mTransition.layoutChange(this);
4370 }
Chet Haase9c087442011-01-12 16:20:16 -08004371 super.layout(l, t, r, b);
4372 } else {
4373 // record the fact that we noop'd it; request layout when transition finishes
4374 mLayoutSuppressed = true;
4375 }
4376 }
4377
4378 /**
4379 * {@inheritDoc}
4380 */
4381 @Override
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004382 protected abstract void onLayout(boolean changed,
4383 int l, int t, int r, int b);
4384
4385 /**
4386 * Indicates whether the view group has the ability to animate its children
4387 * after the first layout.
4388 *
4389 * @return true if the children can be animated, false otherwise
4390 */
4391 protected boolean canAnimate() {
4392 return mLayoutAnimationController != null;
4393 }
4394
4395 /**
4396 * Runs the layout animation. Calling this method triggers a relayout of
4397 * this view group.
4398 */
4399 public void startLayoutAnimation() {
4400 if (mLayoutAnimationController != null) {
4401 mGroupFlags |= FLAG_RUN_ANIMATION;
4402 requestLayout();
4403 }
4404 }
4405
4406 /**
4407 * Schedules the layout animation to be played after the next layout pass
4408 * of this view group. This can be used to restart the layout animation
4409 * when the content of the view group changes or when the activity is
4410 * paused and resumed.
4411 */
4412 public void scheduleLayoutAnimation() {
4413 mGroupFlags |= FLAG_RUN_ANIMATION;
4414 }
4415
4416 /**
4417 * Sets the layout animation controller used to animate the group's
4418 * children after the first layout.
4419 *
4420 * @param controller the animation controller
4421 */
4422 public void setLayoutAnimation(LayoutAnimationController controller) {
4423 mLayoutAnimationController = controller;
4424 if (mLayoutAnimationController != null) {
4425 mGroupFlags |= FLAG_RUN_ANIMATION;
4426 }
4427 }
4428
4429 /**
4430 * Returns the layout animation controller used to animate the group's
4431 * children.
4432 *
4433 * @return the current animation controller
4434 */
4435 public LayoutAnimationController getLayoutAnimation() {
4436 return mLayoutAnimationController;
4437 }
4438
4439 /**
4440 * Indicates whether the children's drawing cache is used during a layout
4441 * animation. By default, the drawing cache is enabled but this will prevent
4442 * nested layout animations from working. To nest animations, you must disable
4443 * the cache.
4444 *
4445 * @return true if the animation cache is enabled, false otherwise
4446 *
4447 * @see #setAnimationCacheEnabled(boolean)
4448 * @see View#setDrawingCacheEnabled(boolean)
4449 */
4450 @ViewDebug.ExportedProperty
4451 public boolean isAnimationCacheEnabled() {
4452 return (mGroupFlags & FLAG_ANIMATION_CACHE) == FLAG_ANIMATION_CACHE;
4453 }
4454
4455 /**
4456 * Enables or disables the children's drawing cache during a layout animation.
4457 * By default, the drawing cache is enabled but this will prevent nested
4458 * layout animations from working. To nest animations, you must disable the
4459 * cache.
4460 *
4461 * @param enabled true to enable the animation cache, false otherwise
4462 *
4463 * @see #isAnimationCacheEnabled()
4464 * @see View#setDrawingCacheEnabled(boolean)
4465 */
4466 public void setAnimationCacheEnabled(boolean enabled) {
4467 setBooleanFlag(FLAG_ANIMATION_CACHE, enabled);
4468 }
4469
4470 /**
4471 * Indicates whether this ViewGroup will always try to draw its children using their
4472 * drawing cache. By default this property is enabled.
4473 *
4474 * @return true if the animation cache is enabled, false otherwise
4475 *
4476 * @see #setAlwaysDrawnWithCacheEnabled(boolean)
4477 * @see #setChildrenDrawnWithCacheEnabled(boolean)
4478 * @see View#setDrawingCacheEnabled(boolean)
4479 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004480 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004481 public boolean isAlwaysDrawnWithCacheEnabled() {
4482 return (mGroupFlags & FLAG_ALWAYS_DRAWN_WITH_CACHE) == FLAG_ALWAYS_DRAWN_WITH_CACHE;
4483 }
4484
4485 /**
4486 * Indicates whether this ViewGroup will always try to draw its children using their
4487 * drawing cache. This property can be set to true when the cache rendering is
4488 * slightly different from the children's normal rendering. Renderings can be different,
4489 * for instance, when the cache's quality is set to low.
4490 *
4491 * When this property is disabled, the ViewGroup will use the drawing cache of its
4492 * children only when asked to. It's usually the task of subclasses to tell ViewGroup
4493 * when to start using the drawing cache and when to stop using it.
4494 *
4495 * @param always true to always draw with the drawing cache, false otherwise
4496 *
4497 * @see #isAlwaysDrawnWithCacheEnabled()
4498 * @see #setChildrenDrawnWithCacheEnabled(boolean)
4499 * @see View#setDrawingCacheEnabled(boolean)
4500 * @see View#setDrawingCacheQuality(int)
4501 */
4502 public void setAlwaysDrawnWithCacheEnabled(boolean always) {
4503 setBooleanFlag(FLAG_ALWAYS_DRAWN_WITH_CACHE, always);
4504 }
4505
4506 /**
4507 * Indicates whether the ViewGroup is currently drawing its children using
4508 * their drawing cache.
4509 *
4510 * @return true if children should be drawn with their cache, false otherwise
4511 *
4512 * @see #setAlwaysDrawnWithCacheEnabled(boolean)
4513 * @see #setChildrenDrawnWithCacheEnabled(boolean)
4514 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004515 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004516 protected boolean isChildrenDrawnWithCacheEnabled() {
4517 return (mGroupFlags & FLAG_CHILDREN_DRAWN_WITH_CACHE) == FLAG_CHILDREN_DRAWN_WITH_CACHE;
4518 }
4519
4520 /**
4521 * Tells the ViewGroup to draw its children using their drawing cache. This property
4522 * is ignored when {@link #isAlwaysDrawnWithCacheEnabled()} is true. A child's drawing cache
4523 * will be used only if it has been enabled.
4524 *
4525 * Subclasses should call this method to start and stop using the drawing cache when
4526 * they perform performance sensitive operations, like scrolling or animating.
4527 *
4528 * @param enabled true if children should be drawn with their cache, false otherwise
4529 *
4530 * @see #setAlwaysDrawnWithCacheEnabled(boolean)
4531 * @see #isChildrenDrawnWithCacheEnabled()
4532 */
4533 protected void setChildrenDrawnWithCacheEnabled(boolean enabled) {
4534 setBooleanFlag(FLAG_CHILDREN_DRAWN_WITH_CACHE, enabled);
4535 }
4536
Romain Guy293451e2009-11-04 13:59:48 -08004537 /**
4538 * Indicates whether the ViewGroup is drawing its children in the order defined by
4539 * {@link #getChildDrawingOrder(int, int)}.
4540 *
4541 * @return true if children drawing order is defined by {@link #getChildDrawingOrder(int, int)},
4542 * false otherwise
4543 *
4544 * @see #setChildrenDrawingOrderEnabled(boolean)
4545 * @see #getChildDrawingOrder(int, int)
4546 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004547 @ViewDebug.ExportedProperty(category = "drawing")
Romain Guy293451e2009-11-04 13:59:48 -08004548 protected boolean isChildrenDrawingOrderEnabled() {
4549 return (mGroupFlags & FLAG_USE_CHILD_DRAWING_ORDER) == FLAG_USE_CHILD_DRAWING_ORDER;
4550 }
4551
4552 /**
4553 * Tells the ViewGroup whether to draw its children in the order defined by the method
4554 * {@link #getChildDrawingOrder(int, int)}.
4555 *
4556 * @param enabled true if the order of the children when drawing is determined by
4557 * {@link #getChildDrawingOrder(int, int)}, false otherwise
4558 *
4559 * @see #isChildrenDrawingOrderEnabled()
4560 * @see #getChildDrawingOrder(int, int)
4561 */
4562 protected void setChildrenDrawingOrderEnabled(boolean enabled) {
4563 setBooleanFlag(FLAG_USE_CHILD_DRAWING_ORDER, enabled);
4564 }
4565
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004566 private void setBooleanFlag(int flag, boolean value) {
4567 if (value) {
4568 mGroupFlags |= flag;
4569 } else {
4570 mGroupFlags &= ~flag;
4571 }
4572 }
4573
4574 /**
4575 * Returns an integer indicating what types of drawing caches are kept in memory.
4576 *
4577 * @see #setPersistentDrawingCache(int)
4578 * @see #setAnimationCacheEnabled(boolean)
4579 *
4580 * @return one or a combination of {@link #PERSISTENT_NO_CACHE},
4581 * {@link #PERSISTENT_ANIMATION_CACHE}, {@link #PERSISTENT_SCROLLING_CACHE}
4582 * and {@link #PERSISTENT_ALL_CACHES}
4583 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004584 @ViewDebug.ExportedProperty(category = "drawing", mapping = {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004585 @ViewDebug.IntToString(from = PERSISTENT_NO_CACHE, to = "NONE"),
Romain Guy203688c2010-05-12 15:41:32 -07004586 @ViewDebug.IntToString(from = PERSISTENT_ANIMATION_CACHE, to = "ANIMATION"),
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004587 @ViewDebug.IntToString(from = PERSISTENT_SCROLLING_CACHE, to = "SCROLLING"),
4588 @ViewDebug.IntToString(from = PERSISTENT_ALL_CACHES, to = "ALL")
4589 })
4590 public int getPersistentDrawingCache() {
4591 return mPersistentDrawingCache;
4592 }
4593
4594 /**
4595 * Indicates what types of drawing caches should be kept in memory after
4596 * they have been created.
4597 *
4598 * @see #getPersistentDrawingCache()
4599 * @see #setAnimationCacheEnabled(boolean)
4600 *
4601 * @param drawingCacheToKeep one or a combination of {@link #PERSISTENT_NO_CACHE},
4602 * {@link #PERSISTENT_ANIMATION_CACHE}, {@link #PERSISTENT_SCROLLING_CACHE}
4603 * and {@link #PERSISTENT_ALL_CACHES}
4604 */
4605 public void setPersistentDrawingCache(int drawingCacheToKeep) {
4606 mPersistentDrawingCache = drawingCacheToKeep & PERSISTENT_ALL_CACHES;
4607 }
4608
4609 /**
Philip Milne7a23b492012-04-24 22:12:36 -07004610 * Returns the basis of alignment during layout operations on this view group:
4611 * either {@link #CLIP_BOUNDS} or {@link #OPTICAL_BOUNDS}.
Philip Milne1557fd72012-04-04 23:41:34 -07004612 *
Philip Milnefcc6a0f2012-04-16 16:12:19 -07004613 * @return the layout mode to use during layout operations
Philip Milne1557fd72012-04-04 23:41:34 -07004614 *
4615 * @see #setLayoutMode(int)
Philip Milne7bb66c92012-05-07 11:42:57 -07004616 *
4617 * @hide
Philip Milne1557fd72012-04-04 23:41:34 -07004618 */
4619 public int getLayoutMode() {
Philip Milne1557fd72012-04-04 23:41:34 -07004620 return mLayoutMode;
4621 }
4622
4623 /**
Philip Milne7a23b492012-04-24 22:12:36 -07004624 * Sets the basis of alignment during the layout of this view group.
4625 * Valid values are either {@link #CLIP_BOUNDS} or {@link #OPTICAL_BOUNDS}.
Philip Milne1557fd72012-04-04 23:41:34 -07004626 * <p>
Philip Milne7a23b492012-04-24 22:12:36 -07004627 * The default is {@link #CLIP_BOUNDS}.
Philip Milne1557fd72012-04-04 23:41:34 -07004628 *
Philip Milnefcc6a0f2012-04-16 16:12:19 -07004629 * @param layoutMode the layout mode to use during layout operations
Philip Milne1557fd72012-04-04 23:41:34 -07004630 *
4631 * @see #getLayoutMode()
Philip Milne7bb66c92012-05-07 11:42:57 -07004632 *
4633 * @hide
Philip Milne1557fd72012-04-04 23:41:34 -07004634 */
4635 public void setLayoutMode(int layoutMode) {
4636 if (mLayoutMode != layoutMode) {
4637 mLayoutMode = layoutMode;
4638 requestLayout();
4639 }
4640 }
4641
4642 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004643 * Returns a new set of layout parameters based on the supplied attributes set.
4644 *
4645 * @param attrs the attributes to build the layout parameters from
4646 *
4647 * @return an instance of {@link android.view.ViewGroup.LayoutParams} or one
4648 * of its descendants
4649 */
4650 public LayoutParams generateLayoutParams(AttributeSet attrs) {
4651 return new LayoutParams(getContext(), attrs);
4652 }
4653
4654 /**
4655 * Returns a safe set of layout parameters based on the supplied layout params.
4656 * When a ViewGroup is passed a View whose layout params do not pass the test of
4657 * {@link #checkLayoutParams(android.view.ViewGroup.LayoutParams)}, this method
4658 * is invoked. This method should return a new set of layout params suitable for
4659 * this ViewGroup, possibly by copying the appropriate attributes from the
4660 * specified set of layout params.
4661 *
4662 * @param p The layout parameters to convert into a suitable set of layout parameters
4663 * for this ViewGroup.
4664 *
4665 * @return an instance of {@link android.view.ViewGroup.LayoutParams} or one
4666 * of its descendants
4667 */
4668 protected LayoutParams generateLayoutParams(ViewGroup.LayoutParams p) {
4669 return p;
4670 }
4671
4672 /**
4673 * Returns a set of default layout parameters. These parameters are requested
4674 * when the View passed to {@link #addView(View)} has no layout parameters
4675 * already set. If null is returned, an exception is thrown from addView.
4676 *
4677 * @return a set of default layout parameters or null
4678 */
4679 protected LayoutParams generateDefaultLayoutParams() {
4680 return new LayoutParams(LayoutParams.WRAP_CONTENT, LayoutParams.WRAP_CONTENT);
4681 }
4682
4683 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004684 * {@inheritDoc}
4685 */
4686 @Override
4687 protected void debug(int depth) {
4688 super.debug(depth);
4689 String output;
4690
4691 if (mFocused != null) {
4692 output = debugIndent(depth);
4693 output += "mFocused";
4694 Log.d(VIEW_LOG_TAG, output);
4695 }
4696 if (mChildrenCount != 0) {
4697 output = debugIndent(depth);
4698 output += "{";
4699 Log.d(VIEW_LOG_TAG, output);
4700 }
4701 int count = mChildrenCount;
4702 for (int i = 0; i < count; i++) {
4703 View child = mChildren[i];
4704 child.debug(depth + 1);
4705 }
4706
4707 if (mChildrenCount != 0) {
4708 output = debugIndent(depth);
4709 output += "}";
4710 Log.d(VIEW_LOG_TAG, output);
4711 }
4712 }
4713
4714 /**
4715 * Returns the position in the group of the specified child view.
4716 *
4717 * @param child the view for which to get the position
4718 * @return a positive integer representing the position of the view in the
4719 * group, or -1 if the view does not exist in the group
4720 */
4721 public int indexOfChild(View child) {
4722 final int count = mChildrenCount;
4723 final View[] children = mChildren;
4724 for (int i = 0; i < count; i++) {
4725 if (children[i] == child) {
4726 return i;
4727 }
4728 }
4729 return -1;
4730 }
4731
4732 /**
4733 * Returns the number of children in the group.
4734 *
4735 * @return a positive integer representing the number of children in
4736 * the group
4737 */
4738 public int getChildCount() {
4739 return mChildrenCount;
4740 }
4741
4742 /**
4743 * Returns the view at the specified position in the group.
4744 *
4745 * @param index the position at which to get the view from
4746 * @return the view at the specified position or null if the position
4747 * does not exist within the group
4748 */
4749 public View getChildAt(int index) {
Adam Powell3ba8f5d2011-03-07 15:36:33 -08004750 if (index < 0 || index >= mChildrenCount) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004751 return null;
4752 }
Adam Powell3ba8f5d2011-03-07 15:36:33 -08004753 return mChildren[index];
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004754 }
4755
4756 /**
4757 * Ask all of the children of this view to measure themselves, taking into
4758 * account both the MeasureSpec requirements for this view and its padding.
4759 * We skip children that are in the GONE state The heavy lifting is done in
4760 * getChildMeasureSpec.
4761 *
4762 * @param widthMeasureSpec The width requirements for this view
4763 * @param heightMeasureSpec The height requirements for this view
4764 */
4765 protected void measureChildren(int widthMeasureSpec, int heightMeasureSpec) {
4766 final int size = mChildrenCount;
4767 final View[] children = mChildren;
4768 for (int i = 0; i < size; ++i) {
4769 final View child = children[i];
4770 if ((child.mViewFlags & VISIBILITY_MASK) != GONE) {
4771 measureChild(child, widthMeasureSpec, heightMeasureSpec);
4772 }
4773 }
4774 }
4775
4776 /**
4777 * Ask one of the children of this view to measure itself, taking into
4778 * account both the MeasureSpec requirements for this view and its padding.
4779 * The heavy lifting is done in getChildMeasureSpec.
4780 *
4781 * @param child The child to measure
4782 * @param parentWidthMeasureSpec The width requirements for this view
4783 * @param parentHeightMeasureSpec The height requirements for this view
4784 */
4785 protected void measureChild(View child, int parentWidthMeasureSpec,
4786 int parentHeightMeasureSpec) {
4787 final LayoutParams lp = child.getLayoutParams();
4788
4789 final int childWidthMeasureSpec = getChildMeasureSpec(parentWidthMeasureSpec,
4790 mPaddingLeft + mPaddingRight, lp.width);
4791 final int childHeightMeasureSpec = getChildMeasureSpec(parentHeightMeasureSpec,
4792 mPaddingTop + mPaddingBottom, lp.height);
4793
4794 child.measure(childWidthMeasureSpec, childHeightMeasureSpec);
4795 }
4796
4797 /**
4798 * Ask one of the children of this view to measure itself, taking into
4799 * account both the MeasureSpec requirements for this view and its padding
4800 * and margins. The child must have MarginLayoutParams The heavy lifting is
4801 * done in getChildMeasureSpec.
4802 *
4803 * @param child The child to measure
4804 * @param parentWidthMeasureSpec The width requirements for this view
4805 * @param widthUsed Extra space that has been used up by the parent
4806 * horizontally (possibly by other children of the parent)
4807 * @param parentHeightMeasureSpec The height requirements for this view
4808 * @param heightUsed Extra space that has been used up by the parent
4809 * vertically (possibly by other children of the parent)
4810 */
4811 protected void measureChildWithMargins(View child,
4812 int parentWidthMeasureSpec, int widthUsed,
4813 int parentHeightMeasureSpec, int heightUsed) {
4814 final MarginLayoutParams lp = (MarginLayoutParams) child.getLayoutParams();
4815
4816 final int childWidthMeasureSpec = getChildMeasureSpec(parentWidthMeasureSpec,
4817 mPaddingLeft + mPaddingRight + lp.leftMargin + lp.rightMargin
4818 + widthUsed, lp.width);
4819 final int childHeightMeasureSpec = getChildMeasureSpec(parentHeightMeasureSpec,
4820 mPaddingTop + mPaddingBottom + lp.topMargin + lp.bottomMargin
4821 + heightUsed, lp.height);
4822
4823 child.measure(childWidthMeasureSpec, childHeightMeasureSpec);
4824 }
4825
4826 /**
4827 * Does the hard part of measureChildren: figuring out the MeasureSpec to
4828 * pass to a particular child. This method figures out the right MeasureSpec
4829 * for one dimension (height or width) of one child view.
4830 *
4831 * The goal is to combine information from our MeasureSpec with the
4832 * LayoutParams of the child to get the best possible results. For example,
4833 * if the this view knows its size (because its MeasureSpec has a mode of
4834 * EXACTLY), and the child has indicated in its LayoutParams that it wants
4835 * to be the same size as the parent, the parent should ask the child to
4836 * layout given an exact size.
4837 *
4838 * @param spec The requirements for this view
4839 * @param padding The padding of this view for the current dimension and
4840 * margins, if applicable
4841 * @param childDimension How big the child wants to be in the current
4842 * dimension
4843 * @return a MeasureSpec integer for the child
4844 */
4845 public static int getChildMeasureSpec(int spec, int padding, int childDimension) {
4846 int specMode = MeasureSpec.getMode(spec);
4847 int specSize = MeasureSpec.getSize(spec);
4848
4849 int size = Math.max(0, specSize - padding);
4850
4851 int resultSize = 0;
4852 int resultMode = 0;
4853
4854 switch (specMode) {
4855 // Parent has imposed an exact size on us
4856 case MeasureSpec.EXACTLY:
4857 if (childDimension >= 0) {
4858 resultSize = childDimension;
4859 resultMode = MeasureSpec.EXACTLY;
Romain Guy980a9382010-01-08 15:06:28 -08004860 } else if (childDimension == LayoutParams.MATCH_PARENT) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004861 // Child wants to be our size. So be it.
4862 resultSize = size;
4863 resultMode = MeasureSpec.EXACTLY;
4864 } else if (childDimension == LayoutParams.WRAP_CONTENT) {
4865 // Child wants to determine its own size. It can't be
4866 // bigger than us.
4867 resultSize = size;
4868 resultMode = MeasureSpec.AT_MOST;
4869 }
4870 break;
4871
4872 // Parent has imposed a maximum size on us
4873 case MeasureSpec.AT_MOST:
4874 if (childDimension >= 0) {
4875 // Child wants a specific size... so be it
4876 resultSize = childDimension;
4877 resultMode = MeasureSpec.EXACTLY;
Romain Guy980a9382010-01-08 15:06:28 -08004878 } else if (childDimension == LayoutParams.MATCH_PARENT) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004879 // Child wants to be our size, but our size is not fixed.
4880 // Constrain child to not be bigger than us.
4881 resultSize = size;
4882 resultMode = MeasureSpec.AT_MOST;
4883 } else if (childDimension == LayoutParams.WRAP_CONTENT) {
4884 // Child wants to determine its own size. It can't be
4885 // bigger than us.
4886 resultSize = size;
4887 resultMode = MeasureSpec.AT_MOST;
4888 }
4889 break;
4890
4891 // Parent asked to see how big we want to be
4892 case MeasureSpec.UNSPECIFIED:
4893 if (childDimension >= 0) {
4894 // Child wants a specific size... let him have it
4895 resultSize = childDimension;
4896 resultMode = MeasureSpec.EXACTLY;
Romain Guy980a9382010-01-08 15:06:28 -08004897 } else if (childDimension == LayoutParams.MATCH_PARENT) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004898 // Child wants to be our size... find out how big it should
4899 // be
4900 resultSize = 0;
4901 resultMode = MeasureSpec.UNSPECIFIED;
4902 } else if (childDimension == LayoutParams.WRAP_CONTENT) {
4903 // Child wants to determine its own size.... find out how
4904 // big it should be
4905 resultSize = 0;
4906 resultMode = MeasureSpec.UNSPECIFIED;
4907 }
4908 break;
4909 }
4910 return MeasureSpec.makeMeasureSpec(resultSize, resultMode);
4911 }
4912
4913
4914 /**
4915 * Removes any pending animations for views that have been removed. Call
4916 * this if you don't want animations for exiting views to stack up.
4917 */
4918 public void clearDisappearingChildren() {
4919 if (mDisappearingChildren != null) {
4920 mDisappearingChildren.clear();
Chet Haaseb85967b2012-03-26 14:37:51 -07004921 invalidate();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004922 }
4923 }
4924
4925 /**
4926 * Add a view which is removed from mChildren but still needs animation
4927 *
4928 * @param v View to add
4929 */
4930 private void addDisappearingView(View v) {
4931 ArrayList<View> disappearingChildren = mDisappearingChildren;
4932
4933 if (disappearingChildren == null) {
4934 disappearingChildren = mDisappearingChildren = new ArrayList<View>();
4935 }
4936
4937 disappearingChildren.add(v);
4938 }
4939
4940 /**
4941 * Cleanup a view when its animation is done. This may mean removing it from
4942 * the list of disappearing views.
4943 *
4944 * @param view The view whose animation has finished
4945 * @param animation The animation, cannot be null
4946 */
Chet Haase64a48c12012-02-13 16:33:29 -08004947 void finishAnimatingView(final View view, Animation animation) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004948 final ArrayList<View> disappearingChildren = mDisappearingChildren;
4949 if (disappearingChildren != null) {
4950 if (disappearingChildren.contains(view)) {
4951 disappearingChildren.remove(view);
4952
4953 if (view.mAttachInfo != null) {
4954 view.dispatchDetachedFromWindow();
4955 }
4956
4957 view.clearAnimation();
4958 mGroupFlags |= FLAG_INVALIDATE_REQUIRED;
4959 }
4960 }
4961
4962 if (animation != null && !animation.getFillAfter()) {
4963 view.clearAnimation();
4964 }
4965
Dianne Hackborn4702a852012-08-17 15:18:29 -07004966 if ((view.mPrivateFlags & PFLAG_ANIMATION_STARTED) == PFLAG_ANIMATION_STARTED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004967 view.onAnimationEnd();
4968 // Should be performed by onAnimationEnd() but this avoid an infinite loop,
4969 // so we'd rather be safe than sorry
Dianne Hackborn4702a852012-08-17 15:18:29 -07004970 view.mPrivateFlags &= ~PFLAG_ANIMATION_STARTED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004971 // Draw one more frame after the animation is done
4972 mGroupFlags |= FLAG_INVALIDATE_REQUIRED;
4973 }
4974 }
4975
Chet Haaseb20db3e2010-09-10 13:07:30 -07004976 /**
Chet Haaseaceafe62011-08-26 15:44:33 -07004977 * Utility function called by View during invalidation to determine whether a view that
4978 * is invisible or gone should still be invalidated because it is being transitioned (and
4979 * therefore still needs to be drawn).
4980 */
4981 boolean isViewTransitioning(View view) {
4982 return (mTransitioningViews != null && mTransitioningViews.contains(view));
4983 }
4984
4985 /**
Chet Haaseb20db3e2010-09-10 13:07:30 -07004986 * This method tells the ViewGroup that the given View object, which should have this
4987 * ViewGroup as its parent,
4988 * should be kept around (re-displayed when the ViewGroup draws its children) even if it
4989 * is removed from its parent. This allows animations, such as those used by
4990 * {@link android.app.Fragment} and {@link android.animation.LayoutTransition} to animate
4991 * the removal of views. A call to this method should always be accompanied by a later call
4992 * to {@link #endViewTransition(View)}, such as after an animation on the View has finished,
4993 * so that the View finally gets removed.
4994 *
4995 * @param view The View object to be kept visible even if it gets removed from its parent.
4996 */
4997 public void startViewTransition(View view) {
4998 if (view.mParent == this) {
4999 if (mTransitioningViews == null) {
5000 mTransitioningViews = new ArrayList<View>();
5001 }
5002 mTransitioningViews.add(view);
5003 }
5004 }
5005
5006 /**
5007 * This method should always be called following an earlier call to
5008 * {@link #startViewTransition(View)}. The given View is finally removed from its parent
5009 * and will no longer be displayed. Note that this method does not perform the functionality
5010 * of removing a view from its parent; it just discontinues the display of a View that
5011 * has previously been removed.
5012 *
5013 * @return view The View object that has been removed but is being kept around in the visible
5014 * hierarchy by an earlier call to {@link #startViewTransition(View)}.
5015 */
5016 public void endViewTransition(View view) {
5017 if (mTransitioningViews != null) {
5018 mTransitioningViews.remove(view);
5019 final ArrayList<View> disappearingChildren = mDisappearingChildren;
5020 if (disappearingChildren != null && disappearingChildren.contains(view)) {
5021 disappearingChildren.remove(view);
Chet Haase5e25c2c2010-09-16 11:15:56 -07005022 if (mVisibilityChangingChildren != null &&
5023 mVisibilityChangingChildren.contains(view)) {
5024 mVisibilityChangingChildren.remove(view);
5025 } else {
5026 if (view.mAttachInfo != null) {
5027 view.dispatchDetachedFromWindow();
5028 }
5029 if (view.mParent != null) {
5030 view.mParent = null;
5031 }
Chet Haaseb20db3e2010-09-10 13:07:30 -07005032 }
Chet Haaseb85967b2012-03-26 14:37:51 -07005033 invalidate();
Chet Haaseb20db3e2010-09-10 13:07:30 -07005034 }
5035 }
5036 }
5037
Chet Haase21cd1382010-09-01 17:42:29 -07005038 private LayoutTransition.TransitionListener mLayoutTransitionListener =
5039 new LayoutTransition.TransitionListener() {
5040 @Override
5041 public void startTransition(LayoutTransition transition, ViewGroup container,
5042 View view, int transitionType) {
5043 // We only care about disappearing items, since we need special logic to keep
5044 // those items visible after they've been 'removed'
5045 if (transitionType == LayoutTransition.DISAPPEARING) {
Chet Haaseb20db3e2010-09-10 13:07:30 -07005046 startViewTransition(view);
Chet Haase21cd1382010-09-01 17:42:29 -07005047 }
5048 }
5049
5050 @Override
5051 public void endTransition(LayoutTransition transition, ViewGroup container,
5052 View view, int transitionType) {
Chet Haase9c087442011-01-12 16:20:16 -08005053 if (mLayoutSuppressed && !transition.isChangingLayout()) {
5054 requestLayout();
5055 mLayoutSuppressed = false;
5056 }
Chet Haase21cd1382010-09-01 17:42:29 -07005057 if (transitionType == LayoutTransition.DISAPPEARING && mTransitioningViews != null) {
Chet Haaseb20db3e2010-09-10 13:07:30 -07005058 endViewTransition(view);
Chet Haase21cd1382010-09-01 17:42:29 -07005059 }
5060 }
5061 };
5062
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005063 /**
5064 * {@inheritDoc}
5065 */
5066 @Override
5067 public boolean gatherTransparentRegion(Region region) {
5068 // If no transparent regions requested, we are always opaque.
Dianne Hackborn4702a852012-08-17 15:18:29 -07005069 final boolean meOpaque = (mPrivateFlags & View.PFLAG_REQUEST_TRANSPARENT_REGIONS) == 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005070 if (meOpaque && region == null) {
5071 // The caller doesn't care about the region, so stop now.
5072 return true;
5073 }
5074 super.gatherTransparentRegion(region);
5075 final View[] children = mChildren;
5076 final int count = mChildrenCount;
5077 boolean noneOfTheChildrenAreTransparent = true;
5078 for (int i = 0; i < count; i++) {
5079 final View child = children[i];
Mathias Agopiane3381152010-12-02 15:19:36 -08005080 if ((child.mViewFlags & VISIBILITY_MASK) == VISIBLE || child.getAnimation() != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005081 if (!child.gatherTransparentRegion(region)) {
5082 noneOfTheChildrenAreTransparent = false;
5083 }
5084 }
5085 }
5086 return meOpaque || noneOfTheChildrenAreTransparent;
5087 }
5088
5089 /**
5090 * {@inheritDoc}
5091 */
5092 public void requestTransparentRegion(View child) {
5093 if (child != null) {
Dianne Hackborn4702a852012-08-17 15:18:29 -07005094 child.mPrivateFlags |= View.PFLAG_REQUEST_TRANSPARENT_REGIONS;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005095 if (mParent != null) {
5096 mParent.requestTransparentRegion(this);
5097 }
5098 }
5099 }
Romain Guy8506ab42009-06-11 17:35:47 -07005100
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005101
5102 @Override
5103 protected boolean fitSystemWindows(Rect insets) {
5104 boolean done = super.fitSystemWindows(insets);
5105 if (!done) {
5106 final int count = mChildrenCount;
5107 final View[] children = mChildren;
5108 for (int i = 0; i < count; i++) {
5109 done = children[i].fitSystemWindows(insets);
5110 if (done) {
5111 break;
5112 }
5113 }
5114 }
5115 return done;
5116 }
5117
5118 /**
5119 * Returns the animation listener to which layout animation events are
5120 * sent.
5121 *
5122 * @return an {@link android.view.animation.Animation.AnimationListener}
5123 */
5124 public Animation.AnimationListener getLayoutAnimationListener() {
5125 return mAnimationListener;
5126 }
5127
5128 @Override
5129 protected void drawableStateChanged() {
5130 super.drawableStateChanged();
5131
5132 if ((mGroupFlags & FLAG_NOTIFY_CHILDREN_ON_DRAWABLE_STATE_CHANGE) != 0) {
5133 if ((mGroupFlags & FLAG_ADD_STATES_FROM_CHILDREN) != 0) {
5134 throw new IllegalStateException("addStateFromChildren cannot be enabled if a"
5135 + " child has duplicateParentState set to true");
5136 }
5137
5138 final View[] children = mChildren;
5139 final int count = mChildrenCount;
5140
5141 for (int i = 0; i < count; i++) {
5142 final View child = children[i];
5143 if ((child.mViewFlags & DUPLICATE_PARENT_STATE) != 0) {
5144 child.refreshDrawableState();
5145 }
5146 }
5147 }
5148 }
5149
5150 @Override
Dianne Hackborne2136772010-11-04 15:08:59 -07005151 public void jumpDrawablesToCurrentState() {
5152 super.jumpDrawablesToCurrentState();
5153 final View[] children = mChildren;
5154 final int count = mChildrenCount;
5155 for (int i = 0; i < count; i++) {
5156 children[i].jumpDrawablesToCurrentState();
5157 }
5158 }
5159
5160 @Override
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005161 protected int[] onCreateDrawableState(int extraSpace) {
5162 if ((mGroupFlags & FLAG_ADD_STATES_FROM_CHILDREN) == 0) {
5163 return super.onCreateDrawableState(extraSpace);
5164 }
5165
5166 int need = 0;
5167 int n = getChildCount();
5168 for (int i = 0; i < n; i++) {
5169 int[] childState = getChildAt(i).getDrawableState();
5170
5171 if (childState != null) {
5172 need += childState.length;
5173 }
5174 }
5175
5176 int[] state = super.onCreateDrawableState(extraSpace + need);
5177
5178 for (int i = 0; i < n; i++) {
5179 int[] childState = getChildAt(i).getDrawableState();
5180
5181 if (childState != null) {
5182 state = mergeDrawableStates(state, childState);
5183 }
5184 }
5185
5186 return state;
5187 }
5188
5189 /**
5190 * Sets whether this ViewGroup's drawable states also include
5191 * its children's drawable states. This is used, for example, to
5192 * make a group appear to be focused when its child EditText or button
5193 * is focused.
5194 */
5195 public void setAddStatesFromChildren(boolean addsStates) {
5196 if (addsStates) {
5197 mGroupFlags |= FLAG_ADD_STATES_FROM_CHILDREN;
5198 } else {
5199 mGroupFlags &= ~FLAG_ADD_STATES_FROM_CHILDREN;
5200 }
5201
5202 refreshDrawableState();
5203 }
5204
5205 /**
5206 * Returns whether this ViewGroup's drawable states also include
5207 * its children's drawable states. This is used, for example, to
5208 * make a group appear to be focused when its child EditText or button
5209 * is focused.
5210 */
5211 public boolean addStatesFromChildren() {
5212 return (mGroupFlags & FLAG_ADD_STATES_FROM_CHILDREN) != 0;
5213 }
5214
5215 /**
Jeff Smitha45746e2012-07-19 14:19:24 -05005216 * If {@link #addStatesFromChildren} is true, refreshes this group's
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005217 * drawable state (to include the states from its children).
5218 */
5219 public void childDrawableStateChanged(View child) {
5220 if ((mGroupFlags & FLAG_ADD_STATES_FROM_CHILDREN) != 0) {
5221 refreshDrawableState();
5222 }
5223 }
5224
5225 /**
5226 * Specifies the animation listener to which layout animation events must
5227 * be sent. Only
5228 * {@link android.view.animation.Animation.AnimationListener#onAnimationStart(Animation)}
5229 * and
5230 * {@link android.view.animation.Animation.AnimationListener#onAnimationEnd(Animation)}
5231 * are invoked.
5232 *
5233 * @param animationListener the layout animation listener
5234 */
5235 public void setLayoutAnimationListener(Animation.AnimationListener animationListener) {
5236 mAnimationListener = animationListener;
5237 }
5238
5239 /**
Chet Haasecca2c982011-05-20 14:34:18 -07005240 * This method is called by LayoutTransition when there are 'changing' animations that need
5241 * to start after the layout/setup phase. The request is forwarded to the ViewAncestor, who
5242 * starts all pending transitions prior to the drawing phase in the current traversal.
5243 *
5244 * @param transition The LayoutTransition to be started on the next traversal.
5245 *
5246 * @hide
5247 */
5248 public void requestTransitionStart(LayoutTransition transition) {
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07005249 ViewRootImpl viewAncestor = getViewRootImpl();
Chet Haase1abf7fa2011-08-17 18:31:56 -07005250 if (viewAncestor != null) {
5251 viewAncestor.requestTransitionStart(transition);
5252 }
Chet Haasecca2c982011-05-20 14:34:18 -07005253 }
5254
Fabrice Di Meglio4457e852012-09-18 19:23:12 -07005255 /**
5256 * @hide
5257 */
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005258 @Override
Fabrice Di Meglio1f88ba82012-09-24 14:56:49 -07005259 public void resolveLayoutDirection() {
5260 super.resolveLayoutDirection();
5261
5262 int count = getChildCount();
5263 for (int i = 0; i < count; i++) {
5264 final View child = getChildAt(i);
5265 if (child.isLayoutDirectionInherited()) {
5266 child.resolveLayoutDirection();
5267 }
5268 }
5269 }
5270
5271 /**
5272 * @hide
5273 */
5274 @Override
5275 public void resolveTextDirection() {
5276 super.resolveTextDirection();
5277
5278 int count = getChildCount();
5279 for (int i = 0; i < count; i++) {
5280 final View child = getChildAt(i);
5281 if (child.isTextDirectionInherited()) {
5282 child.resolveTextDirection();
5283 }
5284 }
5285 }
5286
5287 /**
5288 * @hide
5289 */
5290 @Override
5291 public void resolveTextAlignment() {
5292 super.resolveTextAlignment();
5293
5294 int count = getChildCount();
5295 for (int i = 0; i < count; i++) {
5296 final View child = getChildAt(i);
5297 if (child.isTextAlignmentInherited()) {
5298 child.resolveTextAlignment();
5299 }
5300 }
5301 }
5302
5303 /**
5304 * @hide
5305 */
5306 @Override
Fabrice Di Meglio4457e852012-09-18 19:23:12 -07005307 public void resetResolvedLayoutDirection() {
5308 super.resetResolvedLayoutDirection();
5309
Fabrice Di Meglio4457e852012-09-18 19:23:12 -07005310 int count = getChildCount();
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005311 for (int i = 0; i < count; i++) {
5312 final View child = getChildAt(i);
Fabrice Di Meglioe56ffdc2012-09-23 14:51:16 -07005313 if (child.isLayoutDirectionInherited()) {
Fabrice Di Meglio7f86c802011-07-01 15:09:24 -07005314 child.resetResolvedLayoutDirection();
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005315 }
Fabrice Di Meglio1f88ba82012-09-24 14:56:49 -07005316 }
5317 }
5318
5319 /**
5320 * @hide
5321 */
5322 @Override
5323 public void resetResolvedTextDirection() {
5324 super.resetResolvedTextDirection();
5325
5326 int count = getChildCount();
5327 for (int i = 0; i < count; i++) {
5328 final View child = getChildAt(i);
Fabrice Di Meglio97e146c2012-09-23 15:45:16 -07005329 if (child.isTextDirectionInherited()) {
Fabrice Di Meglio22268862011-06-27 18:13:18 -07005330 child.resetResolvedTextDirection();
5331 }
Fabrice Di Meglio1f88ba82012-09-24 14:56:49 -07005332 }
5333 }
5334
5335 /**
5336 * @hide
5337 */
5338 @Override
5339 public void resetResolvedTextAlignment() {
5340 super.resetResolvedTextAlignment();
5341
5342 int count = getChildCount();
5343 for (int i = 0; i < count; i++) {
5344 final View child = getChildAt(i);
Fabrice Di Meglio1a7d4872012-09-23 16:19:58 -07005345 if (child.isTextAlignmentInherited()) {
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07005346 child.resetResolvedTextAlignment();
5347 }
5348 }
5349 }
5350
Fabrice Di Meglio22268862011-06-27 18:13:18 -07005351 /**
Patrick Dubroye0a799a2011-05-04 16:19:22 -07005352 * Return true if the pressed state should be delayed for children or descendants of this
5353 * ViewGroup. Generally, this should be done for containers that can scroll, such as a List.
5354 * This prevents the pressed state from appearing when the user is actually trying to scroll
5355 * the content.
5356 *
5357 * The default implementation returns true for compatibility reasons. Subclasses that do
5358 * not scroll should generally override this method and return false.
5359 */
5360 public boolean shouldDelayChildPressedState() {
5361 return true;
5362 }
5363
Philip Milned7dd8902012-01-26 16:55:30 -08005364 /** @hide */
5365 protected void onSetLayoutParams(View child, LayoutParams layoutParams) {
5366 }
5367
Patrick Dubroye0a799a2011-05-04 16:19:22 -07005368 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005369 * LayoutParams are used by views to tell their parents how they want to be
5370 * laid out. See
5371 * {@link android.R.styleable#ViewGroup_Layout ViewGroup Layout Attributes}
5372 * for a list of all child view attributes that this class supports.
Romain Guy8506ab42009-06-11 17:35:47 -07005373 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005374 * <p>
5375 * The base LayoutParams class just describes how big the view wants to be
5376 * for both width and height. For each dimension, it can specify one of:
5377 * <ul>
Dirk Dougherty75c66da2010-03-25 16:33:33 -07005378 * <li>FILL_PARENT (renamed MATCH_PARENT in API Level 8 and higher), which
5379 * means that the view wants to be as big as its parent (minus padding)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005380 * <li> WRAP_CONTENT, which means that the view wants to be just big enough
5381 * to enclose its content (plus padding)
Dirk Dougherty75c66da2010-03-25 16:33:33 -07005382 * <li> an exact number
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005383 * </ul>
5384 * There are subclasses of LayoutParams for different subclasses of
5385 * ViewGroup. For example, AbsoluteLayout has its own subclass of
Joe Fernandez558459f2011-10-13 16:47:36 -07005386 * LayoutParams which adds an X and Y value.</p>
5387 *
5388 * <div class="special reference">
5389 * <h3>Developer Guides</h3>
5390 * <p>For more information about creating user interface layouts, read the
5391 * <a href="{@docRoot}guide/topics/ui/declaring-layout.html">XML Layouts</a> developer
5392 * guide.</p></div>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005393 *
5394 * @attr ref android.R.styleable#ViewGroup_Layout_layout_height
5395 * @attr ref android.R.styleable#ViewGroup_Layout_layout_width
5396 */
5397 public static class LayoutParams {
5398 /**
Dirk Dougherty75c66da2010-03-25 16:33:33 -07005399 * Special value for the height or width requested by a View.
5400 * FILL_PARENT means that the view wants to be as big as its parent,
5401 * minus the parent's padding, if any. This value is deprecated
5402 * starting in API Level 8 and replaced by {@link #MATCH_PARENT}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005403 */
Romain Guy980a9382010-01-08 15:06:28 -08005404 @SuppressWarnings({"UnusedDeclaration"})
5405 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005406 public static final int FILL_PARENT = -1;
5407
5408 /**
5409 * Special value for the height or width requested by a View.
Gilles Debunnef5c6eff2010-02-09 19:08:36 -08005410 * MATCH_PARENT means that the view wants to be as big as its parent,
Dirk Dougherty75c66da2010-03-25 16:33:33 -07005411 * minus the parent's padding, if any. Introduced in API Level 8.
Romain Guy980a9382010-01-08 15:06:28 -08005412 */
5413 public static final int MATCH_PARENT = -1;
5414
5415 /**
5416 * Special value for the height or width requested by a View.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005417 * WRAP_CONTENT means that the view wants to be just large enough to fit
5418 * its own internal content, taking its own padding into account.
5419 */
5420 public static final int WRAP_CONTENT = -2;
5421
5422 /**
Dirk Dougherty75c66da2010-03-25 16:33:33 -07005423 * Information about how wide the view wants to be. Can be one of the
5424 * constants FILL_PARENT (replaced by MATCH_PARENT ,
5425 * in API Level 8) or WRAP_CONTENT. or an exact size.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005426 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005427 @ViewDebug.ExportedProperty(category = "layout", mapping = {
Romain Guy980a9382010-01-08 15:06:28 -08005428 @ViewDebug.IntToString(from = MATCH_PARENT, to = "MATCH_PARENT"),
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005429 @ViewDebug.IntToString(from = WRAP_CONTENT, to = "WRAP_CONTENT")
5430 })
5431 public int width;
5432
5433 /**
Dirk Dougherty75c66da2010-03-25 16:33:33 -07005434 * Information about how tall the view wants to be. Can be one of the
5435 * constants FILL_PARENT (replaced by MATCH_PARENT ,
5436 * in API Level 8) or WRAP_CONTENT. or an exact size.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005437 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005438 @ViewDebug.ExportedProperty(category = "layout", mapping = {
Romain Guy980a9382010-01-08 15:06:28 -08005439 @ViewDebug.IntToString(from = MATCH_PARENT, to = "MATCH_PARENT"),
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005440 @ViewDebug.IntToString(from = WRAP_CONTENT, to = "WRAP_CONTENT")
5441 })
5442 public int height;
5443
5444 /**
5445 * Used to animate layouts.
5446 */
5447 public LayoutAnimationController.AnimationParameters layoutAnimationParameters;
5448
5449 /**
5450 * Creates a new set of layout parameters. The values are extracted from
5451 * the supplied attributes set and context. The XML attributes mapped
5452 * to this set of layout parameters are:
5453 *
5454 * <ul>
5455 * <li><code>layout_width</code>: the width, either an exact value,
Dirk Dougherty75c66da2010-03-25 16:33:33 -07005456 * {@link #WRAP_CONTENT}, or {@link #FILL_PARENT} (replaced by
5457 * {@link #MATCH_PARENT} in API Level 8)</li>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005458 * <li><code>layout_height</code>: the height, either an exact value,
Dirk Dougherty75c66da2010-03-25 16:33:33 -07005459 * {@link #WRAP_CONTENT}, or {@link #FILL_PARENT} (replaced by
5460 * {@link #MATCH_PARENT} in API Level 8)</li>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005461 * </ul>
5462 *
5463 * @param c the application environment
5464 * @param attrs the set of attributes from which to extract the layout
5465 * parameters' values
5466 */
5467 public LayoutParams(Context c, AttributeSet attrs) {
5468 TypedArray a = c.obtainStyledAttributes(attrs, R.styleable.ViewGroup_Layout);
5469 setBaseAttributes(a,
5470 R.styleable.ViewGroup_Layout_layout_width,
5471 R.styleable.ViewGroup_Layout_layout_height);
5472 a.recycle();
5473 }
5474
5475 /**
5476 * Creates a new set of layout parameters with the specified width
5477 * and height.
5478 *
Dirk Dougherty75c66da2010-03-25 16:33:33 -07005479 * @param width the width, either {@link #WRAP_CONTENT},
5480 * {@link #FILL_PARENT} (replaced by {@link #MATCH_PARENT} in
5481 * API Level 8), or a fixed size in pixels
5482 * @param height the height, either {@link #WRAP_CONTENT},
5483 * {@link #FILL_PARENT} (replaced by {@link #MATCH_PARENT} in
5484 * API Level 8), or a fixed size in pixels
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005485 */
5486 public LayoutParams(int width, int height) {
5487 this.width = width;
5488 this.height = height;
5489 }
5490
5491 /**
5492 * Copy constructor. Clones the width and height values of the source.
5493 *
5494 * @param source The layout params to copy from.
5495 */
5496 public LayoutParams(LayoutParams source) {
5497 this.width = source.width;
5498 this.height = source.height;
5499 }
5500
5501 /**
5502 * Used internally by MarginLayoutParams.
5503 * @hide
5504 */
5505 LayoutParams() {
5506 }
5507
5508 /**
Philip Milnec29f0312012-02-22 16:34:51 -08005509 * Extracts the <code>width</code> and <code>height</code> layout parameters
5510 * from the supplied TypedArray, <code>a</code>, and assigns them
5511 * to the appropriate fields. If, <code>a</code>, does not contain an
5512 * entry for either attribute, the value, {@link ViewGroup.LayoutParams#WRAP_CONTENT},
5513 * is used as a default.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005514 *
5515 * @param a the style attributes to extract the parameters from
5516 * @param widthAttr the identifier of the width attribute
5517 * @param heightAttr the identifier of the height attribute
5518 */
5519 protected void setBaseAttributes(TypedArray a, int widthAttr, int heightAttr) {
Philip Milnec29f0312012-02-22 16:34:51 -08005520 width = a.getLayoutDimension(widthAttr, WRAP_CONTENT);
5521 height = a.getLayoutDimension(heightAttr, WRAP_CONTENT);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005522 }
5523
5524 /**
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005525 * Resolve layout parameters depending on the layout direction. Subclasses that care about
5526 * layoutDirection changes should override this method. The default implementation does
5527 * nothing.
5528 *
5529 * @param layoutDirection the direction of the layout
5530 *
5531 * {@link View#LAYOUT_DIRECTION_LTR}
5532 * {@link View#LAYOUT_DIRECTION_RTL}
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005533 */
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -08005534 public void onResolveLayoutDirection(int layoutDirection) {
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005535 }
5536
5537 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005538 * Returns a String representation of this set of layout parameters.
5539 *
5540 * @param output the String to prepend to the internal representation
5541 * @return a String with the following format: output +
5542 * "ViewGroup.LayoutParams={ width=WIDTH, height=HEIGHT }"
Romain Guy8506ab42009-06-11 17:35:47 -07005543 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005544 * @hide
5545 */
5546 public String debug(String output) {
5547 return output + "ViewGroup.LayoutParams={ width="
5548 + sizeToString(width) + ", height=" + sizeToString(height) + " }";
5549 }
5550
5551 /**
Philip Milne10ca24a2012-04-23 15:38:27 -07005552 * Use {@code canvas} to draw suitable debugging annotations for these LayoutParameters.
5553 *
5554 * @param view the view that contains these layout parameters
5555 * @param canvas the canvas on which to draw
5556 *
5557 * @hide
5558 */
5559 public void onDebugDraw(View view, Canvas canvas) {
5560 }
5561
5562 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005563 * Converts the specified size to a readable String.
5564 *
5565 * @param size the size to convert
5566 * @return a String instance representing the supplied size
Romain Guy8506ab42009-06-11 17:35:47 -07005567 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005568 * @hide
5569 */
5570 protected static String sizeToString(int size) {
5571 if (size == WRAP_CONTENT) {
5572 return "wrap-content";
5573 }
Romain Guy980a9382010-01-08 15:06:28 -08005574 if (size == MATCH_PARENT) {
5575 return "match-parent";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005576 }
5577 return String.valueOf(size);
5578 }
5579 }
5580
5581 /**
5582 * Per-child layout information for layouts that support margins.
5583 * See
5584 * {@link android.R.styleable#ViewGroup_MarginLayout ViewGroup Margin Layout Attributes}
5585 * for a list of all child view attributes that this class supports.
5586 */
5587 public static class MarginLayoutParams extends ViewGroup.LayoutParams {
5588 /**
Philip Milned7dd8902012-01-26 16:55:30 -08005589 * The left margin in pixels of the child.
5590 * Call {@link ViewGroup#setLayoutParams(LayoutParams)} after reassigning a new value
5591 * to this field.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005592 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005593 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005594 public int leftMargin;
5595
5596 /**
Philip Milned7dd8902012-01-26 16:55:30 -08005597 * The top margin in pixels of the child.
5598 * Call {@link ViewGroup#setLayoutParams(LayoutParams)} after reassigning a new value
5599 * to this field.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005600 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005601 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005602 public int topMargin;
5603
5604 /**
Philip Milned7dd8902012-01-26 16:55:30 -08005605 * The right margin in pixels of the child.
5606 * Call {@link ViewGroup#setLayoutParams(LayoutParams)} after reassigning a new value
5607 * to this field.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005608 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005609 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005610 public int rightMargin;
5611
5612 /**
Philip Milned7dd8902012-01-26 16:55:30 -08005613 * The bottom margin in pixels of the child.
5614 * Call {@link ViewGroup#setLayoutParams(LayoutParams)} after reassigning a new value
5615 * to this field.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005616 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005617 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005618 public int bottomMargin;
5619
5620 /**
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005621 * The start margin in pixels of the child.
Fabrice Di Meglio54546f22012-02-14 16:26:16 -08005622 * Call {@link ViewGroup#setLayoutParams(LayoutParams)} after reassigning a new value
5623 * to this field.
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005624 */
5625 @ViewDebug.ExportedProperty(category = "layout")
Fabrice Di Meglioa40627d2012-09-11 16:47:21 -07005626 private int startMargin = DEFAULT_RELATIVE;
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005627
5628 /**
5629 * The end margin in pixels of the child.
Fabrice Di Meglio54546f22012-02-14 16:26:16 -08005630 * Call {@link ViewGroup#setLayoutParams(LayoutParams)} after reassigning a new value
5631 * to this field.
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005632 */
5633 @ViewDebug.ExportedProperty(category = "layout")
Fabrice Di Meglioa40627d2012-09-11 16:47:21 -07005634 private int endMargin = DEFAULT_RELATIVE;
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005635
5636 /**
5637 * The default start and end margin.
Fabrice Di Megliof443f982012-07-13 20:24:03 -07005638 * @hide
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005639 */
Fabrice Di Megliof443f982012-07-13 20:24:03 -07005640 public static final int DEFAULT_RELATIVE = Integer.MIN_VALUE;
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005641
Fabrice Di Meglio69bd5582012-07-02 13:17:24 -07005642 private int initialLeftMargin;
5643 private int initialRightMargin;
5644
Fabrice Di Megliof443f982012-07-13 20:24:03 -07005645 private static int LAYOUT_DIRECTION_UNDEFINED = -1;
5646
5647 // Layout direction undefined by default
5648 private int layoutDirection = LAYOUT_DIRECTION_UNDEFINED;
Fabrice Di Meglio69bd5582012-07-02 13:17:24 -07005649
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005650 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005651 * Creates a new set of layout parameters. The values are extracted from
5652 * the supplied attributes set and context.
5653 *
5654 * @param c the application environment
5655 * @param attrs the set of attributes from which to extract the layout
5656 * parameters' values
5657 */
5658 public MarginLayoutParams(Context c, AttributeSet attrs) {
5659 super();
5660
5661 TypedArray a = c.obtainStyledAttributes(attrs, R.styleable.ViewGroup_MarginLayout);
5662 setBaseAttributes(a,
5663 R.styleable.ViewGroup_MarginLayout_layout_width,
5664 R.styleable.ViewGroup_MarginLayout_layout_height);
5665
5666 int margin = a.getDimensionPixelSize(
5667 com.android.internal.R.styleable.ViewGroup_MarginLayout_layout_margin, -1);
5668 if (margin >= 0) {
5669 leftMargin = margin;
5670 topMargin = margin;
5671 rightMargin= margin;
5672 bottomMargin = margin;
5673 } else {
5674 leftMargin = a.getDimensionPixelSize(
5675 R.styleable.ViewGroup_MarginLayout_layout_marginLeft, 0);
5676 topMargin = a.getDimensionPixelSize(
5677 R.styleable.ViewGroup_MarginLayout_layout_marginTop, 0);
5678 rightMargin = a.getDimensionPixelSize(
5679 R.styleable.ViewGroup_MarginLayout_layout_marginRight, 0);
5680 bottomMargin = a.getDimensionPixelSize(
5681 R.styleable.ViewGroup_MarginLayout_layout_marginBottom, 0);
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005682 startMargin = a.getDimensionPixelSize(
5683 R.styleable.ViewGroup_MarginLayout_layout_marginStart, DEFAULT_RELATIVE);
5684 endMargin = a.getDimensionPixelSize(
5685 R.styleable.ViewGroup_MarginLayout_layout_marginEnd, DEFAULT_RELATIVE);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005686 }
5687
Fabrice Di Meglio69bd5582012-07-02 13:17:24 -07005688 initialLeftMargin = leftMargin;
5689 initialRightMargin = rightMargin;
5690
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005691 a.recycle();
5692 }
5693
5694 /**
5695 * {@inheritDoc}
5696 */
5697 public MarginLayoutParams(int width, int height) {
5698 super(width, height);
5699 }
5700
5701 /**
5702 * Copy constructor. Clones the width, height and margin values of the source.
5703 *
5704 * @param source The layout params to copy from.
5705 */
5706 public MarginLayoutParams(MarginLayoutParams source) {
5707 this.width = source.width;
5708 this.height = source.height;
5709
5710 this.leftMargin = source.leftMargin;
5711 this.topMargin = source.topMargin;
5712 this.rightMargin = source.rightMargin;
5713 this.bottomMargin = source.bottomMargin;
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005714 this.startMargin = source.startMargin;
5715 this.endMargin = source.endMargin;
Fabrice Di Meglio69bd5582012-07-02 13:17:24 -07005716
5717 this.initialLeftMargin = source.leftMargin;
5718 this.initialRightMargin = source.rightMargin;
5719
Fabrice Di Megliof443f982012-07-13 20:24:03 -07005720 setLayoutDirection(source.layoutDirection);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005721 }
5722
5723 /**
5724 * {@inheritDoc}
5725 */
5726 public MarginLayoutParams(LayoutParams source) {
5727 super(source);
5728 }
5729
5730 /**
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005731 * Sets the margins, in pixels. A call to {@link android.view.View#requestLayout()} needs
5732 * to be done so that the new margins are taken into account. Left and right margins may be
5733 * overriden by {@link android.view.View#requestLayout()} depending on layout direction.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005734 *
5735 * @param left the left margin size
5736 * @param top the top margin size
5737 * @param right the right margin size
5738 * @param bottom the bottom margin size
5739 *
5740 * @attr ref android.R.styleable#ViewGroup_MarginLayout_layout_marginLeft
5741 * @attr ref android.R.styleable#ViewGroup_MarginLayout_layout_marginTop
5742 * @attr ref android.R.styleable#ViewGroup_MarginLayout_layout_marginRight
5743 * @attr ref android.R.styleable#ViewGroup_MarginLayout_layout_marginBottom
5744 */
5745 public void setMargins(int left, int top, int right, int bottom) {
5746 leftMargin = left;
5747 topMargin = top;
5748 rightMargin = right;
5749 bottomMargin = bottom;
Fabrice Di Meglio69bd5582012-07-02 13:17:24 -07005750 initialLeftMargin = left;
5751 initialRightMargin = right;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005752 }
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005753
5754 /**
5755 * Sets the relative margins, in pixels. A call to {@link android.view.View#requestLayout()}
5756 * needs to be done so that the new relative margins are taken into account. Left and right
5757 * margins may be overriden by {@link android.view.View#requestLayout()} depending on layout
5758 * direction.
5759 *
5760 * @param start the start margin size
5761 * @param top the top margin size
5762 * @param end the right margin size
5763 * @param bottom the bottom margin size
5764 *
5765 * @attr ref android.R.styleable#ViewGroup_MarginLayout_layout_marginStart
5766 * @attr ref android.R.styleable#ViewGroup_MarginLayout_layout_marginTop
5767 * @attr ref android.R.styleable#ViewGroup_MarginLayout_layout_marginEnd
5768 * @attr ref android.R.styleable#ViewGroup_MarginLayout_layout_marginBottom
5769 *
5770 * @hide
5771 */
5772 public void setMarginsRelative(int start, int top, int end, int bottom) {
5773 startMargin = start;
5774 topMargin = top;
5775 endMargin = end;
5776 bottomMargin = bottom;
Fabrice Di Meglio69bd5582012-07-02 13:17:24 -07005777 initialLeftMargin = 0;
5778 initialRightMargin = 0;
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005779 }
5780
5781 /**
Fabrice Di Meglioa40627d2012-09-11 16:47:21 -07005782 * Sets the relative start margin.
5783 *
Fabrice Di Meglio61a21772012-09-12 16:33:13 -07005784 * @param start the start margin size
Fabrice Di Meglioa40627d2012-09-11 16:47:21 -07005785 *
5786 * @attr ref android.R.styleable#ViewGroup_MarginLayout_layout_marginStart
5787 */
5788 public void setMarginStart(int start) {
5789 startMargin = start;
5790 }
5791
5792 /**
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005793 * Returns the start margin in pixels.
5794 *
5795 * @attr ref android.R.styleable#ViewGroup_MarginLayout_layout_marginStart
5796 *
5797 * @return the start margin in pixels.
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005798 */
5799 public int getMarginStart() {
Fabrice Di Meglio69bd5582012-07-02 13:17:24 -07005800 if (startMargin != DEFAULT_RELATIVE) return startMargin;
5801 switch(layoutDirection) {
5802 case View.LAYOUT_DIRECTION_RTL:
5803 return rightMargin;
5804 case View.LAYOUT_DIRECTION_LTR:
5805 default:
5806 return leftMargin;
5807 }
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005808 }
5809
5810 /**
Fabrice Di Meglioa40627d2012-09-11 16:47:21 -07005811 * Sets the relative end margin.
5812 *
Fabrice Di Meglio61a21772012-09-12 16:33:13 -07005813 * @param end the end margin size
Fabrice Di Meglioa40627d2012-09-11 16:47:21 -07005814 *
5815 * @attr ref android.R.styleable#ViewGroup_MarginLayout_layout_marginEnd
5816 */
5817 public void setMarginEnd(int end) {
5818 endMargin = end;
5819 }
5820
5821 /**
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005822 * Returns the end margin in pixels.
5823 *
5824 * @attr ref android.R.styleable#ViewGroup_MarginLayout_layout_marginEnd
5825 *
5826 * @return the end margin in pixels.
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005827 */
5828 public int getMarginEnd() {
Fabrice Di Meglio69bd5582012-07-02 13:17:24 -07005829 if (endMargin != DEFAULT_RELATIVE) return endMargin;
5830 switch(layoutDirection) {
5831 case View.LAYOUT_DIRECTION_RTL:
5832 return leftMargin;
5833 case View.LAYOUT_DIRECTION_LTR:
5834 default:
5835 return rightMargin;
5836 }
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005837 }
5838
5839 /**
5840 * Check if margins are relative.
5841 *
5842 * @attr ref android.R.styleable#ViewGroup_MarginLayout_layout_marginStart
5843 * @attr ref android.R.styleable#ViewGroup_MarginLayout_layout_marginEnd
5844 *
Fabrice Di Megliof443f982012-07-13 20:24:03 -07005845 * @return true if either marginStart or marginEnd has been set.
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005846 */
5847 public boolean isMarginRelative() {
5848 return (startMargin != DEFAULT_RELATIVE) || (endMargin != DEFAULT_RELATIVE);
5849 }
5850
5851 /**
Fabrice Di Megliof443f982012-07-13 20:24:03 -07005852 * Set the layout direction
5853 * @param layoutDirection the layout direction.
5854 * Should be either {@link View#LAYOUT_DIRECTION_LTR}
5855 * or {@link View#LAYOUT_DIRECTION_RTL}.
5856 */
5857 public void setLayoutDirection(int layoutDirection) {
5858 if (layoutDirection != View.LAYOUT_DIRECTION_LTR &&
5859 layoutDirection != View.LAYOUT_DIRECTION_RTL) return;
5860 this.layoutDirection = layoutDirection;
5861 }
5862
5863 /**
5864 * Retuns the layout direction. Can be either {@link View#LAYOUT_DIRECTION_LTR} or
5865 * {@link View#LAYOUT_DIRECTION_RTL}.
5866 *
5867 * @return the layout direction.
5868 */
5869 public int getLayoutDirection() {
5870 return layoutDirection;
5871 }
5872
5873 /**
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005874 * This will be called by {@link android.view.View#requestLayout()}. Left and Right margins
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -08005875 * may be overridden depending on layout direction.
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005876 */
5877 @Override
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -08005878 public void onResolveLayoutDirection(int layoutDirection) {
Fabrice Di Megliof443f982012-07-13 20:24:03 -07005879 setLayoutDirection(layoutDirection);
Fabrice Di Meglio69bd5582012-07-02 13:17:24 -07005880
5881 if (!isMarginRelative()) return;
5882
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005883 switch(layoutDirection) {
5884 case View.LAYOUT_DIRECTION_RTL:
Fabrice Di Meglio69bd5582012-07-02 13:17:24 -07005885 leftMargin = (endMargin > DEFAULT_RELATIVE) ? endMargin : initialLeftMargin;
5886 rightMargin = (startMargin > DEFAULT_RELATIVE) ? startMargin : initialRightMargin;
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005887 break;
5888 case View.LAYOUT_DIRECTION_LTR:
5889 default:
Fabrice Di Meglio69bd5582012-07-02 13:17:24 -07005890 leftMargin = (startMargin > DEFAULT_RELATIVE) ? startMargin : initialLeftMargin;
5891 rightMargin = (endMargin > DEFAULT_RELATIVE) ? endMargin : initialRightMargin;
Fabrice Di Megliob76023a2011-06-20 17:41:21 -07005892 break;
5893 }
5894 }
Philip Milne10ca24a2012-04-23 15:38:27 -07005895
Fabrice Di Megliof443f982012-07-13 20:24:03 -07005896 protected boolean isLayoutRtl() {
5897 return (layoutDirection == View.LAYOUT_DIRECTION_RTL);
5898 }
5899
Philip Milne10ca24a2012-04-23 15:38:27 -07005900 /**
5901 * @hide
5902 */
5903 @Override
5904 public void onDebugDraw(View view, Canvas canvas) {
Philip Milne10ca24a2012-04-23 15:38:27 -07005905 drawRect(canvas,
5906 view.getLeft() - leftMargin,
5907 view.getTop() - topMargin,
5908 view.getRight() + rightMargin,
Philip Milne604f4402012-04-24 19:27:11 -07005909 view.getBottom() + bottomMargin, Color.MAGENTA);
Philip Milne10ca24a2012-04-23 15:38:27 -07005910 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005911 }
Adam Powell2b342f02010-08-18 18:14:13 -07005912
Jeff Brown20e987b2010-08-23 12:01:02 -07005913 /* Describes a touched view and the ids of the pointers that it has captured.
5914 *
5915 * This code assumes that pointer ids are always in the range 0..31 such that
5916 * it can use a bitfield to track which pointer ids are present.
5917 * As it happens, the lower layers of the input dispatch pipeline also use the
5918 * same trick so the assumption should be safe here...
5919 */
5920 private static final class TouchTarget {
5921 private static final int MAX_RECYCLED = 32;
5922 private static final Object sRecycleLock = new Object();
5923 private static TouchTarget sRecycleBin;
5924 private static int sRecycledCount;
Adam Powell2b342f02010-08-18 18:14:13 -07005925
Jeff Brown20e987b2010-08-23 12:01:02 -07005926 public static final int ALL_POINTER_IDS = -1; // all ones
Adam Powell2b342f02010-08-18 18:14:13 -07005927
Jeff Brown20e987b2010-08-23 12:01:02 -07005928 // The touched child view.
5929 public View child;
5930
5931 // The combined bit mask of pointer ids for all pointers captured by the target.
5932 public int pointerIdBits;
5933
5934 // The next target in the target list.
5935 public TouchTarget next;
5936
5937 private TouchTarget() {
Adam Powell2b342f02010-08-18 18:14:13 -07005938 }
5939
Jeff Brown20e987b2010-08-23 12:01:02 -07005940 public static TouchTarget obtain(View child, int pointerIdBits) {
5941 final TouchTarget target;
5942 synchronized (sRecycleLock) {
Adam Powell816c3be2010-08-23 18:00:05 -07005943 if (sRecycleBin == null) {
Jeff Brown20e987b2010-08-23 12:01:02 -07005944 target = new TouchTarget();
Adam Powell816c3be2010-08-23 18:00:05 -07005945 } else {
Jeff Brown20e987b2010-08-23 12:01:02 -07005946 target = sRecycleBin;
5947 sRecycleBin = target.next;
5948 sRecycledCount--;
5949 target.next = null;
Adam Powell816c3be2010-08-23 18:00:05 -07005950 }
Adam Powell816c3be2010-08-23 18:00:05 -07005951 }
Jeff Brown20e987b2010-08-23 12:01:02 -07005952 target.child = child;
5953 target.pointerIdBits = pointerIdBits;
5954 return target;
5955 }
Adam Powell816c3be2010-08-23 18:00:05 -07005956
Jeff Brown20e987b2010-08-23 12:01:02 -07005957 public void recycle() {
5958 synchronized (sRecycleLock) {
5959 if (sRecycledCount < MAX_RECYCLED) {
5960 next = sRecycleBin;
5961 sRecycleBin = this;
5962 sRecycledCount += 1;
Patrick Dubroyfb0547d2010-10-19 17:36:18 -07005963 } else {
5964 next = null;
Adam Powell816c3be2010-08-23 18:00:05 -07005965 }
Patrick Dubroyfb0547d2010-10-19 17:36:18 -07005966 child = null;
Adam Powell816c3be2010-08-23 18:00:05 -07005967 }
5968 }
Adam Powell2b342f02010-08-18 18:14:13 -07005969 }
Jeff Brown87b7f802011-06-21 18:35:45 -07005970
5971 /* Describes a hovered view. */
5972 private static final class HoverTarget {
5973 private static final int MAX_RECYCLED = 32;
5974 private static final Object sRecycleLock = new Object();
5975 private static HoverTarget sRecycleBin;
5976 private static int sRecycledCount;
5977
5978 // The hovered child view.
5979 public View child;
5980
5981 // The next target in the target list.
5982 public HoverTarget next;
5983
5984 private HoverTarget() {
5985 }
5986
5987 public static HoverTarget obtain(View child) {
5988 final HoverTarget target;
5989 synchronized (sRecycleLock) {
5990 if (sRecycleBin == null) {
5991 target = new HoverTarget();
5992 } else {
5993 target = sRecycleBin;
5994 sRecycleBin = target.next;
5995 sRecycledCount--;
5996 target.next = null;
5997 }
5998 }
5999 target.child = child;
6000 return target;
6001 }
6002
6003 public void recycle() {
6004 synchronized (sRecycleLock) {
6005 if (sRecycledCount < MAX_RECYCLED) {
6006 next = sRecycleBin;
6007 sRecycleBin = this;
6008 sRecycledCount += 1;
6009 } else {
6010 next = null;
6011 }
6012 child = null;
6013 }
6014 }
6015 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006016
6017 /**
6018 * Pooled class that orderes the children of a ViewGroup from start
6019 * to end based on how they are laid out and the layout direction.
6020 */
6021 static class ChildListForAccessibility {
6022
6023 private static final int MAX_POOL_SIZE = 32;
6024
6025 private static final Object sPoolLock = new Object();
6026
6027 private static ChildListForAccessibility sPool;
6028
6029 private static int sPoolSize;
6030
6031 private boolean mIsPooled;
6032
6033 private ChildListForAccessibility mNext;
6034
6035 private final ArrayList<View> mChildren = new ArrayList<View>();
6036
6037 private final ArrayList<ViewLocationHolder> mHolders = new ArrayList<ViewLocationHolder>();
6038
6039 public static ChildListForAccessibility obtain(ViewGroup parent, boolean sort) {
6040 ChildListForAccessibility list = null;
6041 synchronized (sPoolLock) {
6042 if (sPool != null) {
6043 list = sPool;
6044 sPool = list.mNext;
6045 list.mNext = null;
6046 list.mIsPooled = false;
6047 sPoolSize--;
6048 } else {
6049 list = new ChildListForAccessibility();
6050 }
6051 list.init(parent, sort);
6052 return list;
6053 }
6054 }
6055
6056 public void recycle() {
6057 if (mIsPooled) {
6058 throw new IllegalStateException("Instance already recycled.");
6059 }
6060 clear();
Svetoslav Ganov005b83b2012-04-16 18:17:17 -07006061 synchronized (sPoolLock) {
6062 if (sPoolSize < MAX_POOL_SIZE) {
6063 mNext = sPool;
6064 mIsPooled = true;
6065 sPool = this;
6066 sPoolSize++;
6067 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006068 }
6069 }
6070
6071 public int getChildCount() {
6072 return mChildren.size();
6073 }
6074
6075 public View getChildAt(int index) {
6076 return mChildren.get(index);
6077 }
6078
6079 public int getChildIndex(View child) {
6080 return mChildren.indexOf(child);
6081 }
6082
6083 private void init(ViewGroup parent, boolean sort) {
6084 ArrayList<View> children = mChildren;
6085 final int childCount = parent.getChildCount();
6086 for (int i = 0; i < childCount; i++) {
6087 View child = parent.getChildAt(i);
6088 children.add(child);
6089 }
6090 if (sort) {
6091 ArrayList<ViewLocationHolder> holders = mHolders;
6092 for (int i = 0; i < childCount; i++) {
6093 View child = children.get(i);
6094 ViewLocationHolder holder = ViewLocationHolder.obtain(parent, child);
6095 holders.add(holder);
6096 }
6097 Collections.sort(holders);
6098 for (int i = 0; i < childCount; i++) {
6099 ViewLocationHolder holder = holders.get(i);
6100 children.set(i, holder.mView);
6101 holder.recycle();
6102 }
6103 holders.clear();
6104 }
6105 }
6106
6107 private void clear() {
6108 mChildren.clear();
6109 }
6110 }
6111
6112 /**
6113 * Pooled class that holds a View and its location with respect to
6114 * a specified root. This enables sorting of views based on their
6115 * coordinates without recomputing the position relative to the root
6116 * on every comparison.
6117 */
6118 static class ViewLocationHolder implements Comparable<ViewLocationHolder> {
6119
6120 private static final int MAX_POOL_SIZE = 32;
6121
6122 private static final Object sPoolLock = new Object();
6123
6124 private static ViewLocationHolder sPool;
6125
6126 private static int sPoolSize;
6127
6128 private boolean mIsPooled;
6129
6130 private ViewLocationHolder mNext;
6131
6132 private final Rect mLocation = new Rect();
6133
6134 public View mView;
6135
6136 private int mLayoutDirection;
6137
6138 public static ViewLocationHolder obtain(ViewGroup root, View view) {
6139 ViewLocationHolder holder = null;
6140 synchronized (sPoolLock) {
6141 if (sPool != null) {
6142 holder = sPool;
6143 sPool = holder.mNext;
6144 holder.mNext = null;
6145 holder.mIsPooled = false;
6146 sPoolSize--;
6147 } else {
6148 holder = new ViewLocationHolder();
6149 }
6150 holder.init(root, view);
6151 return holder;
6152 }
6153 }
6154
6155 public void recycle() {
6156 if (mIsPooled) {
6157 throw new IllegalStateException("Instance already recycled.");
6158 }
6159 clear();
Svetoslav Ganov005b83b2012-04-16 18:17:17 -07006160 synchronized (sPoolLock) {
6161 if (sPoolSize < MAX_POOL_SIZE) {
6162 mNext = sPool;
6163 mIsPooled = true;
6164 sPool = this;
6165 sPoolSize++;
6166 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006167 }
6168 }
6169
6170 @Override
6171 public int compareTo(ViewLocationHolder another) {
6172 // This instance is greater than an invalid argument.
6173 if (another == null) {
6174 return 1;
6175 }
6176 if (getClass() != another.getClass()) {
6177 return 1;
6178 }
6179 // First is above second.
6180 if (mLocation.bottom - another.mLocation.top <= 0) {
6181 return -1;
6182 }
6183 // First is below second.
6184 if (mLocation.top - another.mLocation.bottom >= 0) {
6185 return 1;
6186 }
6187 // LTR
6188 if (mLayoutDirection == LAYOUT_DIRECTION_LTR) {
6189 final int leftDifference = mLocation.left - another.mLocation.left;
6190 // First more to the left than second.
6191 if (leftDifference != 0) {
6192 return leftDifference;
6193 }
6194 } else { // RTL
6195 final int rightDifference = mLocation.right - another.mLocation.right;
6196 // First more to the right than second.
6197 if (rightDifference != 0) {
6198 return -rightDifference;
6199 }
6200 }
6201 // Break tie by top.
6202 final int topDiference = mLocation.top - another.mLocation.top;
6203 if (topDiference != 0) {
6204 return topDiference;
6205 }
6206 // Break tie by height.
6207 final int heightDiference = mLocation.height() - another.mLocation.height();
6208 if (heightDiference != 0) {
6209 return -heightDiference;
6210 }
6211 // Break tie by width.
6212 final int widthDiference = mLocation.width() - another.mLocation.width();
6213 if (widthDiference != 0) {
6214 return -widthDiference;
6215 }
Svetoslav Ganov005b83b2012-04-16 18:17:17 -07006216 // Just break the tie somehow. The accessibliity ids are unique
6217 // and stable, hence this is deterministic tie breaking.
6218 return mView.getAccessibilityViewId() - another.mView.getAccessibilityViewId();
Svetoslav Ganov42138042012-03-20 11:51:39 -07006219 }
6220
6221 private void init(ViewGroup root, View view) {
6222 Rect viewLocation = mLocation;
6223 view.getDrawingRect(viewLocation);
6224 root.offsetDescendantRectToMyCoords(view, viewLocation);
6225 mView = view;
Fabrice Di Meglioe56ffdc2012-09-23 14:51:16 -07006226 mLayoutDirection = root.getLayoutDirection();
Svetoslav Ganov42138042012-03-20 11:51:39 -07006227 }
6228
6229 private void clear() {
6230 mView = null;
6231 mLocation.set(0, 0, 0, 0);
6232 }
6233 }
Romain Guycbc67742012-04-27 16:12:57 -07006234
6235 private static Paint getDebugPaint() {
6236 if (sDebugPaint == null) {
6237 sDebugPaint = new Paint();
6238 sDebugPaint.setAntiAlias(false);
6239 }
6240 return sDebugPaint;
6241 }
6242
6243 private static float[] getDebugLines(int x1, int y1, int x2, int y2) {
6244 if (sDebugLines== null) {
6245 sDebugLines = new float[16];
6246 }
6247
6248 x2--;
6249 y2--;
6250
6251 sDebugLines[0] = x1;
6252 sDebugLines[1] = y1;
6253 sDebugLines[2] = x2;
6254 sDebugLines[3] = y1;
6255
6256 sDebugLines[4] = x2;
6257 sDebugLines[5] = y1;
6258 sDebugLines[6] = x2;
6259 sDebugLines[7] = y2 + 1;
6260
6261 sDebugLines[8] = x2 + 1;
6262 sDebugLines[9] = y2;
6263 sDebugLines[10] = x1;
6264 sDebugLines[11] = y2;
6265
6266 sDebugLines[12] = x1;
6267 sDebugLines[13] = y2;
6268 sDebugLines[14] = x1;
6269 sDebugLines[15] = y1;
6270
6271 return sDebugLines;
6272 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006273}