ViewGroupCompat

Added in 1.1.0

public final class ViewGroupCompat


Helper for accessing features in ViewGroup.

Summary

Constants

static final int

This constant is a layoutMode.

static final int

This constant is a layoutMode.

Public methods

static int

Returns the basis of alignment during layout operations on this ViewGroup: either LAYOUT_MODE_CLIP_BOUNDS or LAYOUT_MODE_OPTICAL_BOUNDS.

static int

Return the current axes of nested scrolling for this ViewGroup.

static boolean

Returns true if this ViewGroup should be considered as a single entity for removal when executing an Activity transition.

static boolean
onRequestSendAccessibilityEvent(
    ViewGroup group,
    View child,
    AccessibilityEvent event
)

This method is deprecated.

Use onRequestSendAccessibilityEvent directly.

static void
setLayoutMode(@NonNull ViewGroup group, int mode)

Sets the basis of alignment during the layout of this ViewGroup.

static void
setMotionEventSplittingEnabled(ViewGroup group, boolean split)

This method is deprecated.

Use setMotionEventSplittingEnabled directly.

static void
setTransitionGroup(@NonNull ViewGroup group, boolean isTransitionGroup)

Changes whether or not this ViewGroup should be treated as a single entity during Activity Transitions.

Constants

LAYOUT_MODE_CLIP_BOUNDS

Added in 1.1.0
public static final int LAYOUT_MODE_CLIP_BOUNDS = 0

This constant is a layoutMode. Clip bounds are the raw values of left, top, right and bottom.

LAYOUT_MODE_OPTICAL_BOUNDS

Added in 1.1.0
public static final int LAYOUT_MODE_OPTICAL_BOUNDS = 1

This constant is a layoutMode. Optical bounds describe where a widget appears to be. They sit inside the clip bounds which need to cover a larger area to allow other effects, such as shadows and glows, to be drawn.

Public methods

getLayoutMode

Added in 1.1.0
public static int getLayoutMode(@NonNull ViewGroup group)

Returns the basis of alignment during layout operations on this ViewGroup: either LAYOUT_MODE_CLIP_BOUNDS or LAYOUT_MODE_OPTICAL_BOUNDS.

If no layoutMode was explicitly set, either programmatically or in an XML resource, the method returns the layoutMode of the view's parent ViewGroup if such a parent exists, otherwise the method returns a default value of LAYOUT_MODE_CLIP_BOUNDS.

Returns
int

the layout mode to use during layout operations

See also
setLayoutMode

getNestedScrollAxes

Added in 1.1.0
public static int getNestedScrollAxes(@NonNull ViewGroup group)

Return the current axes of nested scrolling for this ViewGroup.

A ViewGroup returning something other than SCROLL_AXIS_NONE is currently acting as a nested scrolling parent for one or more descendant views in the hierarchy.

Returns
int

Flags indicating the current axes of nested scrolling

isTransitionGroup

Added in 1.1.0
public static boolean isTransitionGroup(@NonNull ViewGroup group)

Returns true if this ViewGroup should be considered as a single entity for removal when executing an Activity transition. If this is false, child elements will move individually during the transition.

onRequestSendAccessibilityEvent

Added in 1.1.0
Deprecated in 1.1.0
public static boolean onRequestSendAccessibilityEvent(
    ViewGroup group,
    View child,
    AccessibilityEvent event
)

Called when a child has requested sending an AccessibilityEvent and gives an opportunity to its parent to augment the event.

If an AccessibilityDelegateCompat has been specified via calling setAccessibilityDelegate its onRequestSendAccessibilityEvent is responsible for handling this call.

Parameters
ViewGroup group

The group whose method to invoke.

View child

The child which requests sending the event.

AccessibilityEvent event

The event to be sent.

Returns
boolean

True if the event should be sent.

setLayoutMode

Added in 1.1.0
public static void setLayoutMode(@NonNull ViewGroup group, int mode)

Sets the basis of alignment during the layout of this ViewGroup. Valid values are either LAYOUT_MODE_CLIP_BOUNDS or LAYOUT_MODE_OPTICAL_BOUNDS.

Parameters
@NonNull ViewGroup group

ViewGroup for which to set the mode.

int mode

the layout mode to use during layout operations

See also
getLayoutMode

setMotionEventSplittingEnabled

Added in 1.1.0
Deprecated in 1.1.0
public static void setMotionEventSplittingEnabled(ViewGroup group, boolean split)

Enable or disable the splitting of MotionEvents to multiple children during touch event dispatch. This behavior is enabled by default for applications that target an SDK version of 11 (Honeycomb) or newer. On earlier platform versions this feature was not supported and this method is a no-op.

When this option is enabled MotionEvents may be split and dispatched to different child views depending on where each pointer initially went down. This allows for user interactions such as scrolling two panes of content independently, chording of buttons, and performing independent gestures on different pieces of content.

Parameters
ViewGroup group

ViewGroup to modify

boolean split

true to allow MotionEvents to be split and dispatched to multiple child views. false to only allow one child view to be the target of any MotionEvent received by this ViewGroup.

setTransitionGroup

Added in 1.1.0
public static void setTransitionGroup(@NonNull ViewGroup group, boolean isTransitionGroup)

Changes whether or not this ViewGroup should be treated as a single entity during Activity Transitions.

Parameters
@NonNull ViewGroup group

ViewGroup for which to set the mode.

boolean isTransitionGroup

Whether or not the ViewGroup should be treated as a unit in Activity transitions. If false, the ViewGroup won't transition, only its children. If true, the entire ViewGroup will transition together.