DrawerLayout

Artifact: androidx.drawerlayout:drawerlayout

Added in 1.0.0

Kotlin |Java

public class DrawerLayout extends ViewGroup implements Openable

java.lang.Object
↳	android.view.View
	↳	android.view.ViewGroup
		↳	androidx.drawerlayout.widget.DrawerLayout

DrawerLayout acts as a top-level container for window content that allows for interactive "drawer" views to be pulled out from one or both vertical edges of the window.

Drawer positioning and layout is controlled using the android:layout_gravity attribute on child views corresponding to which side of the view you want the drawer to emerge from: left or right (or start/end on platform versions that support layout direction.) Note that you can only have one drawer view for each vertical edge of the window. If your layout configures more than one drawer view per vertical edge of the window, an exception will be thrown at runtime.

To use a DrawerLayout, position your primary content view as the first child with width and height of match_parent and no layout_gravity>. Add drawers as child views after the main content view and set the layout_gravity appropriately. Drawers commonly use match_parent for height with a fixed width.

DrawerListener can be used to monitor the state and motion of drawer views. Avoid performing expensive operations such as layout during animation as it can cause stuttering; try to perform expensive operations during the STATE_IDLE state. SimpleDrawerListener offers default/no-op implementations of each callback method.

As per the Android Design guide, any drawers positioned to the left/start should always contain content for navigating around the application, whereas any drawers positioned to the right/end should always contain actions to take on the current content. This preserves the same navigation left, actions right structure present in the Action Bar and elsewhere.

For more information about how to use DrawerLayout, read Creating a Navigation Drawer.

Summary

Nested types
`public interface DrawerLayout.DrawerListener` Listener for monitoring events about drawers.
`public class DrawerLayout.LayoutParams extends ViewGroup.MarginLayoutParams`
`protected class DrawerLayout.SavedState extends AbsSavedState` State persisted across instances
`public abstract class DrawerLayout.SimpleDrawerListener implements DrawerLayout.DrawerListener` Stub/no-op implementations of all methods of `DrawerListener`.

Constants
`static final int`	`LOCK_MODE_LOCKED_CLOSED = 1` The drawer is locked closed.
`static final int`	`LOCK_MODE_LOCKED_OPEN = 2` The drawer is locked open.
`static final int`	`LOCK_MODE_UNDEFINED = 3` The drawer's lock state is reset to default.
`static final int`	`LOCK_MODE_UNLOCKED = 0` The drawer is unlocked.
`static final int`	`STATE_DRAGGING = 1` Indicates that a drawer is currently being dragged by the user.
`static final int`	`STATE_IDLE = 0` Indicates that any drawers are in an idle, settled state.
`static final int`	`STATE_SETTLING = 2` Indicates that a drawer is in the process of settling to a final position.

Public constructors
`DrawerLayout(@NonNull Context context)`
`DrawerLayout(@NonNull Context context, @Nullable AttributeSet attrs)`
`DrawerLayout( @NonNull Context context, @Nullable AttributeSet attrs, int defStyleAttr )`

Public methods
`void`	`addDrawerListener(@NonNull DrawerLayout.DrawerListener listener)` Adds the specified listener to the list of listeners that will be notified of drawer events.
`void`	`addFocusables(ArrayList<View> views, int direction, int focusableMode)`
`void`	`addView(View child, int index, ViewGroup.LayoutParams params)`
`void`	`close()` Close the `START` drawer by animating it out of view.
`void`	`closeDrawer(@NonNull View drawerView)` Close the specified drawer view by animating it into view.
`void`	`closeDrawer(int gravity)` Close the specified drawer by animating it out of view.
`void`	`closeDrawer(@NonNull View drawerView, boolean animate)` Close the specified drawer view.
`void`	`closeDrawer(int gravity, boolean animate)` Close the specified drawer.
`void`	`closeDrawers()` Close all currently open drawer views by animating them out of view.
`void`	`computeScroll()`
`boolean`	`dispatchGenericMotionEvent(MotionEvent event)`
`ViewGroup.LayoutParams`	`generateLayoutParams(AttributeSet attrs)`
`float`	`getDrawerElevation()` The base elevation of the drawer(s) relative to the parent, in pixels.
`int`	`getDrawerLockMode(@NonNull View drawerView)` Check the lock mode of the given drawer view.
`int`	`getDrawerLockMode(int edgeGravity)` Check the lock mode of the drawer with the given gravity.
`@Nullable CharSequence`	`getDrawerTitle(int edgeGravity)` Returns the title of the drawer with the given gravity.
`@Nullable Drawable`	`getStatusBarBackgroundDrawable()` Gets the drawable used to draw in the insets area for the status bar.
`boolean`	`isDrawerOpen(int drawerGravity)` Check if the given drawer view is currently in an open state.
`boolean`	`isDrawerOpen(@NonNull View drawer)` Check if the given drawer view is currently in an open state.
`boolean`	`isDrawerVisible(int drawerGravity)` Check if a given drawer view is currently visible on-screen.
`boolean`	`isDrawerVisible(@NonNull View drawer)` Check if a given drawer view is currently visible on-screen.
`boolean`	`isOpen()` Check if the `START` drawer is currently in an open state.
`void`	`onDraw(@NonNull Canvas c)`
`boolean`	`onInterceptTouchEvent(MotionEvent ev)`
`boolean`	`onKeyDown(int keyCode, KeyEvent event)`
`boolean`	`onKeyUp(int keyCode, KeyEvent event)`
`void`	`onRtlPropertiesChanged(int layoutDirection)`
`boolean`	`onTouchEvent(MotionEvent ev)`
`void`	`open()` Open the `START` drawer by animating it into view.
`void`	`openDrawer(@NonNull View drawerView)` Open the specified drawer view by animating it into view.
`void`	`openDrawer(int gravity)` Open the specified drawer by animating it out of view.
`void`	`openDrawer(@NonNull View drawerView, boolean animate)` Open the specified drawer view.
`void`	`openDrawer(int gravity, boolean animate)` Open the specified drawer.
`void`	`removeDrawerListener(@NonNull DrawerLayout.DrawerListener listener)` Removes the specified listener from the list of listeners that will be notified of drawer events.
`void`	`requestDisallowInterceptTouchEvent(boolean disallowIntercept)`
`void`	`requestLayout()`
`void`	`setDrawerElevation(float elevation)` Sets the base elevation of the drawer(s) relative to the parent, in pixels.
`void`	`setDrawerListener(DrawerLayout.DrawerListener listener)` This method is deprecated. Use `addDrawerListener`
`void`	`setDrawerLockMode(int lockMode)` Enable or disable interaction with all drawers.
`void`	`setDrawerLockMode(int lockMode, @NonNull View drawerView)` Enable or disable interaction with the given drawer.
`void`	`setDrawerLockMode(int lockMode, int edgeGravity)` Enable or disable interaction with the given drawer.
`void`	`setDrawerShadow(@DrawableRes int resId, int gravity)` Set a simple drawable used for the left or right shadow.
`void`	`setDrawerShadow(@Nullable Drawable shadowDrawable, int gravity)` Set a simple drawable used for the left or right shadow.
`void`	`setDrawerTitle(int edgeGravity, @Nullable CharSequence title)` Sets the title of the drawer with the given gravity.
`void`	`setScrimColor(@ColorInt int color)` Set a color to use for the scrim that obscures primary content while a drawer is open.
`void`	`setStatusBarBackground(@Nullable Drawable bg)` Set a drawable to draw in the insets area for the status bar.
`void`	`setStatusBarBackground(int resId)` Set a drawable to draw in the insets area for the status bar.
`void`	`setStatusBarBackgroundColor(@ColorInt int color)` Set a drawable to draw in the insets area for the status bar.

Protected methods
`boolean`	`checkLayoutParams(ViewGroup.LayoutParams p)`
`boolean`	`drawChild(@NonNull Canvas canvas, View child, long drawingTime)`
`ViewGroup.LayoutParams`	`generateDefaultLayoutParams()`
`ViewGroup.LayoutParams`	`generateLayoutParams(ViewGroup.LayoutParams p)`
`void`	`onAttachedToWindow()`
`void`	`onDetachedFromWindow()`
`void`	`onLayout(boolean changed, int l, int t, int r, int b)`
`void`	`onMeasure(int widthMeasureSpec, int heightMeasureSpec)`
`void`	`onRestoreInstanceState(Parcelable state)`
`@NonNull Parcelable`	`onSaveInstanceState()`

Inherited Constants

From android.view.View

`static final int`	`ACCESSIBILITY_DATA_SENSITIVE_AUTO = 0`
`static final int`	`ACCESSIBILITY_DATA_SENSITIVE_NO = 2`
`static final int`	`ACCESSIBILITY_DATA_SENSITIVE_YES = 1`
`static final int`	`ACCESSIBILITY_LIVE_REGION_ASSERTIVE = 2`
`static final int`	`ACCESSIBILITY_LIVE_REGION_NONE = 0`
`static final int`	`ACCESSIBILITY_LIVE_REGION_POLITE = 1`
`static final Property<View, Float>`	`ALPHA`
`static final int`	`AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS = 1`
`static final String`	`AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE = "creditCardExpirationDate"`
`static final String`	`AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY = "creditCardExpirationDay"`
`static final String`	`AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH = "creditCardExpirationMonth"`
`static final String`	`AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR = "creditCardExpirationYear"`
`static final String`	`AUTOFILL_HINT_CREDIT_CARD_NUMBER = "creditCardNumber"`
`static final String`	`AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE = "creditCardSecurityCode"`
`static final String`	`AUTOFILL_HINT_EMAIL_ADDRESS = "emailAddress"`
`static final String`	`AUTOFILL_HINT_NAME = "name"`
`static final String`	`AUTOFILL_HINT_PASSWORD = "password"`
`static final String`	`AUTOFILL_HINT_PHONE = "phone"`
`static final String`	`AUTOFILL_HINT_POSTAL_ADDRESS = "postalAddress"`
`static final String`	`AUTOFILL_HINT_POSTAL_CODE = "postalCode"`
`static final String`	`AUTOFILL_HINT_USERNAME = "username"`
`static final int`	`AUTOFILL_TYPE_DATE = 4`
`static final int`	`AUTOFILL_TYPE_LIST = 3`
`static final int`	`AUTOFILL_TYPE_NONE = 0`
`static final int`	`AUTOFILL_TYPE_TEXT = 1`
`static final int`	`AUTOFILL_TYPE_TOGGLE = 2`
`static final int`	`CONTENT_SENSITIVITY_AUTO = 0`
`static final int`	`CONTENT_SENSITIVITY_NOT_SENSITIVE = 2`
`static final int`	`CONTENT_SENSITIVITY_SENSITIVE = 1`
`static final int`	`DRAG_FLAG_ACCESSIBILITY_ACTION = 1024`
`static final int`	`DRAG_FLAG_GLOBAL = 256`
`static final int`	`DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION = 64`
`static final int`	`DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION = 128`
`static final int`	`DRAG_FLAG_GLOBAL_SAME_APPLICATION = 4096`
`static final int`	`DRAG_FLAG_GLOBAL_URI_READ = 1`
`static final int`	`DRAG_FLAG_GLOBAL_URI_WRITE = 2`
`static final int`	`DRAG_FLAG_HIDE_CALLING_TASK_ON_DRAG_START = 16384`
`static final int`	`DRAG_FLAG_OPAQUE = 512`
`static final int`	`DRAG_FLAG_START_INTENT_SENDER_ON_UNHANDLED_DRAG = 8192`
`static final int`	`DRAWING_CACHE_QUALITY_AUTO = 0` This field is deprecated.
`static final int`	`DRAWING_CACHE_QUALITY_HIGH = 1048576` This field is deprecated.
`static final int`	`DRAWING_CACHE_QUALITY_LOW = 524288` This field is deprecated.
`static final int[]`	`EMPTY_STATE_SET`
`static final int[]`	`ENABLED_FOCUSED_SELECTED_STATE_SET`
`static final int[]`	`ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`ENABLED_FOCUSED_STATE_SET`
`static final int[]`	`ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`ENABLED_SELECTED_STATE_SET`
`static final int[]`	`ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`ENABLED_STATE_SET`
`static final int[]`	`ENABLED_WINDOW_FOCUSED_STATE_SET`
`static final int`	`FIND_VIEWS_WITH_CONTENT_DESCRIPTION = 2`
`static final int`	`FIND_VIEWS_WITH_TEXT = 1`
`static final int`	`FOCUSABLE = 1`
`static final int`	`FOCUSABLES_ALL = 0`
`static final int`	`FOCUSABLES_TOUCH_MODE = 1`
`static final int`	`FOCUSABLE_AUTO = 16`
`static final int[]`	`FOCUSED_SELECTED_STATE_SET`
`static final int[]`	`FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`FOCUSED_STATE_SET`
`static final int[]`	`FOCUSED_WINDOW_FOCUSED_STATE_SET`
`static final int`	`FOCUS_BACKWARD = 1`
`static final int`	`FOCUS_DOWN = 130`
`static final int`	`FOCUS_FORWARD = 2`
`static final int`	`FOCUS_LEFT = 17`
`static final int`	`FOCUS_RIGHT = 66`
`static final int`	`FOCUS_UP = 33`
`static final int`	`GONE = 8`
`static final int`	`HAPTIC_FEEDBACK_ENABLED = 268435456`
`static final int`	`IMPORTANT_FOR_ACCESSIBILITY_AUTO = 0`
`static final int`	`IMPORTANT_FOR_ACCESSIBILITY_NO = 2`
`static final int`	`IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS = 4`
`static final int`	`IMPORTANT_FOR_ACCESSIBILITY_YES = 1`
`static final int`	`IMPORTANT_FOR_AUTOFILL_AUTO = 0`
`static final int`	`IMPORTANT_FOR_AUTOFILL_NO = 2`
`static final int`	`IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS = 8`
`static final int`	`IMPORTANT_FOR_AUTOFILL_YES = 1`
`static final int`	`IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS = 4`
`static final int`	`IMPORTANT_FOR_CONTENT_CAPTURE_AUTO = 0`
`static final int`	`IMPORTANT_FOR_CONTENT_CAPTURE_NO = 2`
`static final int`	`IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS = 8`
`static final int`	`IMPORTANT_FOR_CONTENT_CAPTURE_YES = 1`
`static final int`	`IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS = 4`
`static final int`	`INVISIBLE = 4`
`static final int`	`KEEP_SCREEN_ON = 67108864`
`static final int`	`LAYER_TYPE_HARDWARE = 2`
`static final int`	`LAYER_TYPE_NONE = 0`
`static final int`	`LAYER_TYPE_SOFTWARE = 1`
`static final int`	`LAYOUT_DIRECTION_INHERIT = 2`
`static final int`	`LAYOUT_DIRECTION_LOCALE = 3`
`static final int`	`LAYOUT_DIRECTION_LTR = 0`
`static final int`	`LAYOUT_DIRECTION_RTL = 1`
`static final int`	`MEASURED_HEIGHT_STATE_SHIFT = 16`
`static final int`	`MEASURED_SIZE_MASK = 16777215`
`static final int`	`MEASURED_STATE_MASK = -16777216`
`static final int`	`MEASURED_STATE_TOO_SMALL = 16777216`
`static final int`	`NOT_FOCUSABLE = 0`
`static final int`	`NO_ID = -1`
`static final int`	`OVER_SCROLL_ALWAYS = 0`
`static final int`	`OVER_SCROLL_IF_CONTENT_SCROLLS = 1`
`static final int`	`OVER_SCROLL_NEVER = 2`
`static final int[]`	`PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_SELECTED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_FOCUSED_SELECTED_STATE_SET`
`static final int[]`	`PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_SELECTED_STATE_SET`
`static final int[]`	`PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_STATE_SET`
`static final int[]`	`PRESSED_WINDOW_FOCUSED_STATE_SET`
`static final float`	`REQUESTED_FRAME_RATE_CATEGORY_DEFAULT`
`static final float`	`REQUESTED_FRAME_RATE_CATEGORY_HIGH = -4.0f`
`static final float`	`REQUESTED_FRAME_RATE_CATEGORY_LOW = -2.0f`
`static final float`	`REQUESTED_FRAME_RATE_CATEGORY_NORMAL = -3.0f`
`static final float`	`REQUESTED_FRAME_RATE_CATEGORY_NO_PREFERENCE = -1.0f`
`static final Property<View, Float>`	`ROTATION`
`static final Property<View, Float>`	`ROTATION_X`
`static final Property<View, Float>`	`ROTATION_Y`
`static final Property<View, Float>`	`SCALE_X`
`static final Property<View, Float>`	`SCALE_Y`
`static final int`	`SCREEN_STATE_OFF = 0`
`static final int`	`SCREEN_STATE_ON = 1`
`static final int`	`SCROLLBARS_INSIDE_INSET = 16777216`
`static final int`	`SCROLLBARS_INSIDE_OVERLAY = 0`
`static final int`	`SCROLLBARS_OUTSIDE_INSET = 50331648`
`static final int`	`SCROLLBARS_OUTSIDE_OVERLAY = 33554432`
`static final int`	`SCROLLBAR_POSITION_DEFAULT = 0`
`static final int`	`SCROLLBAR_POSITION_LEFT = 1`
`static final int`	`SCROLLBAR_POSITION_RIGHT = 2`
`static final int`	`SCROLL_AXIS_HORIZONTAL = 1`
`static final int`	`SCROLL_AXIS_NONE = 0`
`static final int`	`SCROLL_AXIS_VERTICAL = 2`
`static final int`	`SCROLL_CAPTURE_HINT_AUTO = 0`
`static final int`	`SCROLL_CAPTURE_HINT_EXCLUDE = 1`
`static final int`	`SCROLL_CAPTURE_HINT_EXCLUDE_DESCENDANTS = 4`
`static final int`	`SCROLL_CAPTURE_HINT_INCLUDE = 2`
`static final int`	`SCROLL_INDICATOR_BOTTOM = 2`
`static final int`	`SCROLL_INDICATOR_END = 32`
`static final int`	`SCROLL_INDICATOR_LEFT = 4`
`static final int`	`SCROLL_INDICATOR_RIGHT = 8`
`static final int`	`SCROLL_INDICATOR_START = 16`
`static final int`	`SCROLL_INDICATOR_TOP = 1`
`static final int[]`	`SELECTED_STATE_SET`
`static final int[]`	`SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int`	`SOUND_EFFECTS_ENABLED = 134217728`
`static final int`	`STATUS_BAR_HIDDEN = 1` This field is deprecated.
`static final int`	`STATUS_BAR_VISIBLE = 0` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_FULLSCREEN = 4` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_HIDE_NAVIGATION = 2` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_IMMERSIVE = 2048` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_IMMERSIVE_STICKY = 4096` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN = 1024` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION = 512` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_LAYOUT_STABLE = 256` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR = 16` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_LIGHT_STATUS_BAR = 8192` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_LOW_PROFILE = 1` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_VISIBLE = 0` This field is deprecated.
`static final int`	`SYSTEM_UI_LAYOUT_FLAGS = 1536` This field is deprecated.
`static final int`	`TEXT_ALIGNMENT_CENTER = 4`
`static final int`	`TEXT_ALIGNMENT_GRAVITY = 1`
`static final int`	`TEXT_ALIGNMENT_INHERIT = 0`
`static final int`	`TEXT_ALIGNMENT_TEXT_END = 3`
`static final int`	`TEXT_ALIGNMENT_TEXT_START = 2`
`static final int`	`TEXT_ALIGNMENT_VIEW_END = 6`
`static final int`	`TEXT_ALIGNMENT_VIEW_START = 5`
`static final int`	`TEXT_DIRECTION_ANY_RTL = 2`
`static final int`	`TEXT_DIRECTION_FIRST_STRONG = 1`
`static final int`	`TEXT_DIRECTION_FIRST_STRONG_LTR = 6`
`static final int`	`TEXT_DIRECTION_FIRST_STRONG_RTL = 7`
`static final int`	`TEXT_DIRECTION_INHERIT = 0`
`static final int`	`TEXT_DIRECTION_LOCALE = 5`
`static final int`	`TEXT_DIRECTION_LTR = 3`
`static final int`	`TEXT_DIRECTION_RTL = 4`
`static final Property<View, Float>`	`TRANSLATION_X`
`static final Property<View, Float>`	`TRANSLATION_Y`
`static final Property<View, Float>`	`TRANSLATION_Z`
`static final String`	`VIEW_LOG_TAG = "View"`
`static final int`	`VISIBLE = 0`
`static final int[]`	`WINDOW_FOCUSED_STATE_SET`
`static final Property<View, Float>`	`X`
`static final Property<View, Float>`	`Y`
`static final Property<View, Float>`	`Z`

From android.view.ViewGroup

`static final int`	`CLIP_TO_PADDING_MASK = 34`
`static final int`	`FOCUS_AFTER_DESCENDANTS = 262144`
`static final int`	`FOCUS_BEFORE_DESCENDANTS = 131072`
`static final int`	`FOCUS_BLOCK_DESCENDANTS = 393216`
`static final int`	`LAYOUT_MODE_CLIP_BOUNDS = 0`
`static final int`	`LAYOUT_MODE_OPTICAL_BOUNDS = 1`
`static final int`	`PERSISTENT_ALL_CACHES = 3` This field is deprecated.
`static final int`	`PERSISTENT_ANIMATION_CACHE = 1` This field is deprecated.
`static final int`	`PERSISTENT_NO_CACHE = 0` This field is deprecated.
`static final int`	`PERSISTENT_SCROLLING_CACHE = 2` This field is deprecated.

Inherited methods

From android.view.View

`void`	`addOnAttachStateChangeListener( View.OnAttachStateChangeListener listener )`
`void`	`addOnLayoutChangeListener(View.OnLayoutChangeListener listener)`
`void`	`addOnUnhandledKeyEventListener( View.OnUnhandledKeyEventListener listener )`
`ViewPropertyAnimator`	`animate()`
`void`	`announceForAccessibility(CharSequence text)` This method is deprecated.
`void`	`autofill(SparseArray<AutofillValue> values)`
`boolean`	`awakenScrollBars()`
`void`	`bringToFront()`
`void`	`buildDrawingCache()` This method is deprecated.
`void`	`buildLayer()`
`boolean`	`callOnClick()`
`boolean`	`canResolveLayoutDirection()`
`boolean`	`canResolveTextAlignment()`
`boolean`	`canResolveTextDirection()`
`boolean`	`canScrollHorizontally(int direction)`
`boolean`	`canScrollVertically(int direction)`
`final void`	`cancelDragAndDrop()`
`void`	`cancelLongPress()`
`final void`	`cancelPendingInputEvents()`
`boolean`	`checkInputConnectionProxy(View view)`
`void`	`clearAnimation()`
`void`	`clearPendingCredentialRequest()`
`void`	`clearViewTranslationCallback()`
`static int`	`combineMeasuredStates(int curState, int newState)`
`int`	`computeHorizontalScrollExtent()`
`int`	`computeHorizontalScrollOffset()`
`int`	`computeHorizontalScrollRange()`
`WindowInsets`	`computeSystemWindowInsets(WindowInsets in, Rect outLocalInsets)`
`int`	`computeVerticalScrollExtent()`
`int`	`computeVerticalScrollOffset()`
`int`	`computeVerticalScrollRange()`
`AccessibilityNodeInfo`	`createAccessibilityNodeInfo()`
`void`	`createContextMenu(ContextMenu menu)`
`void`	`destroyDrawingCache()` This method is deprecated.
`boolean`	`dispatchNestedFling(float velocityX, float velocityY, boolean consumed)`
`boolean`	`dispatchNestedPreFling(float velocityX, float velocityY)`
`boolean`	`dispatchNestedPrePerformAccessibilityAction( int action, Bundle arguments )`
`boolean`	`dispatchNestedPreScroll( int dx, int dy, int[] consumed, int[] offsetInWindow )`
`boolean`	`dispatchNestedScroll( int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, int[] offsetInWindow )`
`boolean`	`dispatchPopulateAccessibilityEvent(AccessibilityEvent event)`
`void`	`draw(Canvas canvas)`
`void`	`drawableHotspotChanged(float x, float y)`
`final OnBackInvokedDispatcher`	`findOnBackInvokedDispatcher()`
`final T`	`<T extends View> findViewById(int id)`
`final T`	`<T extends View> findViewWithTag(Object tag)`
`boolean`	`fitSystemWindows(Rect insets)` This method is deprecated.
`void`	`forceHasOverlappingRendering(boolean hasOverlappingRendering)`
`void`	`forceLayout()`
`void`	`generateDisplayHash( String hashAlgorithm, Rect bounds, Executor executor, DisplayHashResultCallback callback )`
`static int`	`generateViewId()`
`View.AccessibilityDelegate`	`getAccessibilityDelegate()`
`int`	`getAccessibilityLiveRegion()`
`AccessibilityNodeProvider`	`getAccessibilityNodeProvider()`
`CharSequence`	`getAccessibilityPaneTitle()`
`int`	`getAccessibilityTraversalAfter()`
`int`	`getAccessibilityTraversalBefore()`
`String`	`getAllowedHandwritingDelegatePackageName()`
`String`	`getAllowedHandwritingDelegatorPackageName()`
`float`	`getAlpha()`
`Animation`	`getAnimation()`
`Matrix`	`getAnimationMatrix()`
`IBinder`	`getApplicationWindowToken()`
`int[]`	`getAttributeResolutionStack(int attribute)`
`Map<Integer, Integer>`	`getAttributeSourceResourceMap()`
`String[]`	`getAutofillHints()`
`final AutofillId`	`getAutofillId()`
`int`	`getAutofillType()`
`AutofillValue`	`getAutofillValue()`
`Drawable`	`getBackground()`
`BlendMode`	`getBackgroundTintBlendMode()`
`ColorStateList`	`getBackgroundTintList()`
`PorterDuff.Mode`	`getBackgroundTintMode()`
`int`	`getBaseline()`
`final int`	`getBottom()`
`float`	`getBottomFadingEdgeStrength()`
`int`	`getBottomPaddingOffset()`
`float`	`getCameraDistance()`
`Rect`	`getClipBounds()`
`boolean`	`getClipBounds(Rect outRect)`
`final boolean`	`getClipToOutline()`
`final ContentCaptureSession`	`getContentCaptureSession()`
`CharSequence`	`getContentDescription()`
`final int`	`getContentSensitivity()`
`final Context`	`getContext()`
`ContextMenu.ContextMenuInfo`	`getContextMenuInfo()`
`final boolean`	`getDefaultFocusHighlightEnabled()`
`static int`	`getDefaultSize(int size, int measureSpec)`
`Display`	`getDisplay()`
`final int[]`	`getDrawableState()`
`Bitmap`	`getDrawingCache()` This method is deprecated.
`int`	`getDrawingCacheBackgroundColor()` This method is deprecated.
`int`	`getDrawingCacheQuality()` This method is deprecated.
`void`	`getDrawingRect(Rect outRect)`
`long`	`getDrawingTime()`
`float`	`getElevation()`
`int`	`getExplicitStyle()`
`boolean`	`getFilterTouchesWhenObscured()`
`boolean`	`getFitsSystemWindows()`
`int`	`getFocusable()`
`ArrayList<View>`	`getFocusables(int direction)`
`void`	`getFocusedRect(Rect r)`
`Drawable`	`getForeground()`
`int`	`getForegroundGravity()`
`BlendMode`	`getForegroundTintBlendMode()`
`ColorStateList`	`getForegroundTintList()`
`PorterDuff.Mode`	`getForegroundTintMode()`
`float`	`getFrameContentVelocity()`
`final boolean`	`getGlobalVisibleRect(Rect r)`
`Handler`	`getHandler()`
`float`	`getHandwritingBoundsOffsetBottom()`
`float`	`getHandwritingBoundsOffsetLeft()`
`float`	`getHandwritingBoundsOffsetRight()`
`float`	`getHandwritingBoundsOffsetTop()`
`int`	`getHandwritingDelegateFlags()`
`Runnable`	`getHandwritingDelegatorCallback()`
`final boolean`	`getHasOverlappingRendering()`
`final int`	`getHeight()`
`void`	`getHitRect(Rect outRect)`
`int`	`getHorizontalFadingEdgeLength()`
`int`	`getHorizontalScrollbarHeight()`
`Drawable`	`getHorizontalScrollbarThumbDrawable()`
`Drawable`	`getHorizontalScrollbarTrackDrawable()`
`int`	`getId()`
`int`	`getImportantForAccessibility()`
`int`	`getImportantForAutofill()`
`int`	`getImportantForContentCapture()`
`boolean`	`getKeepScreenOn()`
`KeyEvent.DispatcherState`	`getKeyDispatcherState()`
`int`	`getLabelFor()`
`int`	`getLayerType()`
`int`	`getLayoutDirection()`
`ViewGroup.LayoutParams`	`getLayoutParams()`
`final int`	`getLeft()`
`float`	`getLeftFadingEdgeStrength()`
`int`	`getLeftPaddingOffset()`
`final boolean`	`getLocalVisibleRect(Rect r)`
`void`	`getLocationInSurface(int[] location)`
`void`	`getLocationInWindow(int[] outLocation)`
`void`	`getLocationOnScreen(int[] outLocation)`
`Matrix`	`getMatrix()`
`final int`	`getMeasuredHeight()`
`final int`	`getMeasuredHeightAndState()`
`final int`	`getMeasuredState()`
`final int`	`getMeasuredWidth()`
`final int`	`getMeasuredWidthAndState()`
`int`	`getMinimumHeight()`
`int`	`getMinimumWidth()`
`int`	`getNextClusterForwardId()`
`int`	`getNextFocusDownId()`
`int`	`getNextFocusForwardId()`
`int`	`getNextFocusLeftId()`
`int`	`getNextFocusRightId()`
`int`	`getNextFocusUpId()`
`View.OnFocusChangeListener`	`getOnFocusChangeListener()`
`int`	`getOutlineAmbientShadowColor()`
`ViewOutlineProvider`	`getOutlineProvider()`
`int`	`getOutlineSpotShadowColor()`
`int`	`getOverScrollMode()`
`ViewOverlay`	`getOverlay()`
`int`	`getPaddingBottom()`
`int`	`getPaddingEnd()`
`int`	`getPaddingLeft()`
`int`	`getPaddingRight()`
`int`	`getPaddingStart()`
`int`	`getPaddingTop()`
`final ViewParent`	`getParent()`
`ViewParent`	`getParentForAccessibility()`
`final OutcomeReceiver<GetCredentialResponse, GetCredentialException>`	`getPendingCredentialCallback()`
`final GetCredentialRequest`	`getPendingCredentialRequest()`
`float`	`getPivotX()`
`float`	`getPivotY()`
`PointerIcon`	`getPointerIcon()`
`final List<Rect>`	`getPreferKeepClearRects()`
`String[]`	`getReceiveContentMimeTypes()`
`float`	`getRequestedFrameRate()`
`Resources`	`getResources()`
`final boolean`	`getRevealOnFocusHint()`
`final int`	`getRight()`
`float`	`getRightFadingEdgeStrength()`
`int`	`getRightPaddingOffset()`
`AttachedSurfaceControl`	`getRootSurfaceControl()`
`View`	`getRootView()`
`WindowInsets`	`getRootWindowInsets()`
`float`	`getRotation()`
`float`	`getRotationX()`
`float`	`getRotationY()`
`float`	`getScaleX()`
`float`	`getScaleY()`
`int`	`getScrollBarDefaultDelayBeforeFade()`
`int`	`getScrollBarFadeDuration()`
`int`	`getScrollBarSize()`
`int`	`getScrollBarStyle()`
`int`	`getScrollCaptureHint()`
`int`	`getScrollIndicators()`
`final int`	`getScrollX()`
`final int`	`getScrollY()`
`int`	`getSolidColor()`
`int`	`getSourceLayoutResId()`
`final CharSequence`	`getStateDescription()`
`StateListAnimator`	`getStateListAnimator()`
`int`	`getSuggestedMinimumHeight()`
`int`	`getSuggestedMinimumWidth()`
`CharSequence`	`getSupplementalDescription()`
`List<Rect>`	`getSystemGestureExclusionRects()`
`int`	`getSystemUiVisibility()` This method is deprecated.
`Object`	`getTag()`
`int`	`getTextAlignment()`
`int`	`getTextDirection()`
`CharSequence`	`getTooltipText()`
`final int`	`getTop()`
`float`	`getTopFadingEdgeStrength()`
`int`	`getTopPaddingOffset()`
`TouchDelegate`	`getTouchDelegate()`
`ArrayList<View>`	`getTouchables()`
`float`	`getTransitionAlpha()`
`String`	`getTransitionName()`
`float`	`getTranslationX()`
`float`	`getTranslationY()`
`float`	`getTranslationZ()`
`long`	`getUniqueDrawingId()`
`int`	`getVerticalFadingEdgeLength()`
`int`	`getVerticalScrollbarPosition()`
`Drawable`	`getVerticalScrollbarThumbDrawable()`
`Drawable`	`getVerticalScrollbarTrackDrawable()`
`int`	`getVerticalScrollbarWidth()`
`ViewTranslationResponse`	`getViewTranslationResponse()`
`ViewTreeObserver`	`getViewTreeObserver()`
`int`	`getVisibility()`
`final int`	`getWidth()`
`int`	`getWindowAttachCount()`
`WindowId`	`getWindowId()`
`WindowInsetsController`	`getWindowInsetsController()`
`int`	`getWindowSystemUiVisibility()` This method is deprecated.
`IBinder`	`getWindowToken()`
`int`	`getWindowVisibility()`
`void`	`getWindowVisibleDisplayFrame(Rect outRect)`
`float`	`getX()`
`float`	`getY()`
`float`	`getZ()`
`boolean`	`hasExplicitFocusable()`
`boolean`	`hasFocusable()`
`boolean`	`hasNestedScrollingParent()`
`boolean`	`hasOnClickListeners()`
`boolean`	`hasOnLongClickListeners()`
`boolean`	`hasOverlappingRendering()`
`boolean`	`hasPointerCapture()`
`boolean`	`hasWindowFocus()`
`static View`	`inflate(Context context, int resource, ViewGroup root)`
`void`	`invalidate()`
`void`	`invalidateDrawable(Drawable drawable)`
`void`	`invalidateOutline()`
`boolean`	`isAccessibilityDataSensitive()`
`boolean`	`isAccessibilityFocused()`
`boolean`	`isAccessibilityHeading()`
`boolean`	`isActivated()`
`boolean`	`isAttachedToWindow()`
`boolean`	`isAutoHandwritingEnabled()`
`boolean`	`isClickable()`
`final boolean`	`isContentSensitive()`
`boolean`	`isContextClickable()`
`boolean`	`isCredential()`
`boolean`	`isDirty()`
`boolean`	`isDrawingCacheEnabled()` This method is deprecated.
`boolean`	`isDuplicateParentStateEnabled()`
`boolean`	`isEnabled()`
`final boolean`	`isFocusable()`
`final boolean`	`isFocusableInTouchMode()`
`boolean`	`isFocused()`
`final boolean`	`isFocusedByDefault()`
`boolean`	`isForceDarkAllowed()`
`boolean`	`isHandwritingDelegate()`
`boolean`	`isHapticFeedbackEnabled()`
`boolean`	`isHardwareAccelerated()`
`boolean`	`isHorizontalFadingEdgeEnabled()`
`boolean`	`isHorizontalScrollBarEnabled()`
`boolean`	`isHovered()`
`boolean`	`isImportantForAccessibility()`
`final boolean`	`isImportantForAutofill()`
`final boolean`	`isImportantForContentCapture()`
`boolean`	`isInEditMode()`
`boolean`	`isInLayout()`
`boolean`	`isInTouchMode()`
`final boolean`	`isKeyboardNavigationCluster()`
`boolean`	`isLaidOut()`
`boolean`	`isLayoutDirectionResolved()`
`boolean`	`isLayoutRequested()`
`boolean`	`isLongClickable()`
`boolean`	`isNestedScrollingEnabled()`
`boolean`	`isOpaque()`
`boolean`	`isPaddingOffsetRequired()`
`boolean`	`isPaddingRelative()`
`boolean`	`isPivotSet()`
`final boolean`	`isPreferKeepClear()`
`boolean`	`isPressed()`
`boolean`	`isSaveEnabled()`
`boolean`	`isSaveFromParentEnabled()`
`boolean`	`isScreenReaderFocusable()`
`boolean`	`isScrollContainer()`
`boolean`	`isScrollbarFadingEnabled()`
`boolean`	`isSelected()`
`final boolean`	`isShowingLayoutBounds()`
`boolean`	`isShown()`
`boolean`	`isSoundEffectsEnabled()`
`final boolean`	`isTemporarilyDetached()`
`boolean`	`isTextAlignmentResolved()`
`boolean`	`isTextDirectionResolved()`
`boolean`	`isVerticalFadingEdgeEnabled()`
`boolean`	`isVerticalScrollBarEnabled()`
`boolean`	`isVisibleToUserForAutofill(int virtualId)`
`View`	`keyboardNavigationClusterSearch(View currentCluster, int direction)`
`final void`	`measure(int widthMeasureSpec, int heightMeasureSpec)`
`static int[]`	`mergeDrawableStates(int[] baseState, int[] additionalState)`
`void`	`offsetLeftAndRight(int offset)`
`void`	`offsetTopAndBottom(int offset)`
`void`	`onAnimationEnd()`
`void`	`onAnimationStart()`
`WindowInsets`	`onApplyWindowInsets(WindowInsets insets)`
`void`	`onCancelPendingInputEvents()`
`boolean`	`onCapturedPointerEvent(MotionEvent event)`
`boolean`	`onCheckIsTextEditor()`
`void`	`onConfigurationChanged(Configuration newConfig)`
`void`	`onCreateContextMenu(ContextMenu menu)`
`InputConnection`	`onCreateInputConnection(EditorInfo outAttrs)`
`void`	`onCreateViewTranslationRequest( int[] supportedFormats, Consumer<ViewTranslationRequest> requestsCollector )`
`void`	`onCreateVirtualViewTranslationRequests( long[] virtualIds, int[] supportedFormats, Consumer<ViewTranslationRequest> requestsCollector )`
`void`	`onDisplayHint(int hint)`
`boolean`	`onDragEvent(DragEvent event)`
`void`	`onDrawForeground(Canvas canvas)`
`final void`	`onDrawScrollBars(Canvas canvas)`
`boolean`	`onFilterTouchEventForSecurity(MotionEvent event)`
`void`	`onFinishInflate()`
`void`	`onFinishTemporaryDetach()`
`void`	`onFocusChanged( boolean gainFocus, int direction, Rect previouslyFocusedRect )`
`boolean`	`onGenericMotionEvent(MotionEvent event)`
`void`	`onHoverChanged(boolean hovered)`
`boolean`	`onHoverEvent(MotionEvent event)`
`void`	`onInitializeAccessibilityEvent(AccessibilityEvent event)`
`void`	`onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info)`
`boolean`	`onKeyLongPress(int keyCode, KeyEvent event)`
`boolean`	`onKeyMultiple(int keyCode, int repeatCount, KeyEvent event)`
`boolean`	`onKeyPreIme(int keyCode, KeyEvent event)`
`boolean`	`onKeyShortcut(int keyCode, KeyEvent event)`
`void`	`onOverScrolled( int scrollX, int scrollY, boolean clampedX, boolean clampedY )`
`void`	`onPointerCaptureChange(boolean hasCapture)`
`void`	`onPopulateAccessibilityEvent(AccessibilityEvent event)`
`void`	`onProvideAutofillStructure(ViewStructure structure, int flags)`
`void`	`onProvideAutofillVirtualStructure(ViewStructure structure, int flags)`
`void`	`onProvideContentCaptureStructure(ViewStructure structure, int flags)`
`void`	`onProvideStructure(ViewStructure structure)`
`void`	`onProvideVirtualStructure(ViewStructure structure)`
`ContentInfo`	`onReceiveContent(ContentInfo payload)`
`void`	`onScreenStateChanged(int screenState)`
`void`	`onScrollCaptureSearch( Rect localVisibleRect, Point windowOffset, Consumer<ScrollCaptureTarget> targets )`
`void`	`onScrollChanged(int l, int t, int oldl, int oldt)`
`boolean`	`onSetAlpha(int alpha)`
`void`	`onSizeChanged(int w, int h, int oldw, int oldh)`
`void`	`onStartTemporaryDetach()`
`boolean`	`onTrackballEvent(MotionEvent event)`
`void`	`onViewTranslationResponse(ViewTranslationResponse response)`
`void`	`onVirtualViewTranslationResponses( LongSparseArray<ViewTranslationResponse> response )`
`void`	`onVisibilityAggregated(boolean isVisible)`
`void`	`onVisibilityChanged(View changedView, int visibility)`
`void`	`onWindowFocusChanged(boolean hasWindowFocus)`
`void`	`onWindowSystemUiVisibilityChanged(int visible)` This method is deprecated.
`void`	`onWindowVisibilityChanged(int visibility)`
`boolean`	`overScrollBy( int deltaX, int deltaY, int scrollX, int scrollY, int scrollRangeX, int scrollRangeY, int maxOverScrollX, int maxOverScrollY, boolean isTouchEvent )`
`boolean`	`performAccessibilityAction(int action, Bundle arguments)`
`boolean`	`performClick()`
`boolean`	`performContextClick()`
`boolean`	`performHapticFeedback(int feedbackConstant)`
`boolean`	`performLongClick()`
`ContentInfo`	`performReceiveContent(ContentInfo payload)`
`void`	`playSoundEffect(int soundConstant)`
`boolean`	`post(Runnable action)`
`boolean`	`postDelayed(Runnable action, long delayMillis)`
`void`	`postInvalidate()`
`void`	`postInvalidateDelayed(long delayMilliseconds)`
`void`	`postInvalidateOnAnimation()`
`void`	`postOnAnimation(Runnable action)`
`void`	`postOnAnimationDelayed(Runnable action, long delayMillis)`
`void`	`refreshDrawableState()`
`void`	`releasePointerCapture()`
`boolean`	`removeCallbacks(Runnable action)`
`void`	`removeOnAttachStateChangeListener( View.OnAttachStateChangeListener listener )`
`void`	`removeOnLayoutChangeListener(View.OnLayoutChangeListener listener)`
`void`	`removeOnUnhandledKeyEventListener( View.OnUnhandledKeyEventListener listener )`
`void`	`reportAppJankStats(AppJankStats appJankStats)`
`void`	`requestApplyInsets()`
`void`	`requestFitSystemWindows()` This method is deprecated.
`final boolean`	`requestFocusFromTouch()`
`void`	`requestPointerCapture()`
`boolean`	`requestRectangleOnScreen(Rect rectangle)`
`final void`	`requestUnbufferedDispatch(MotionEvent event)`
`final T`	`<T extends View> requireViewById(int id)`
`void`	`resetPivot()`
`static int`	`resolveSize(int size, int measureSpec)`
`static int`	`resolveSizeAndState(int size, int measureSpec, int childMeasuredState)`
`void`	`restoreHierarchyState(SparseArray<Parcelable> container)`
`final void`	`saveAttributeDataForStyleable( Context context, int[] styleable, AttributeSet attrs, TypedArray t, int defStyleAttr, int defStyleRes )`
`void`	`saveHierarchyState(SparseArray<Parcelable> container)`
`void`	`scheduleDrawable(Drawable who, Runnable what, long when)`
`void`	`scrollBy(int x, int y)`
`void`	`scrollTo(int x, int y)`
`void`	`sendAccessibilityEvent(int eventType)`
`void`	`sendAccessibilityEventUnchecked(AccessibilityEvent event)`
`void`	`setAccessibilityDataSensitive(int accessibilityDataSensitive)`
`void`	`setAccessibilityDelegate(View.AccessibilityDelegate delegate)`
`void`	`setAccessibilityHeading(boolean isHeading)`
`void`	`setAccessibilityLiveRegion(int mode)`
`void`	`setAccessibilityPaneTitle(CharSequence accessibilityPaneTitle)`
`void`	`setAccessibilityTraversalAfter(int afterId)`
`void`	`setAccessibilityTraversalBefore(int beforeId)`
`void`	`setActivated(boolean activated)`
`void`	`setAllowClickWhenDisabled(boolean clickableWhenDisabled)`
`void`	`setAllowedHandwritingDelegatePackage(String allowedPackageName)`
`void`	`setAllowedHandwritingDelegatorPackage(String allowedPackageName)`
`void`	`setAlpha(float alpha)`
`void`	`setAnimation(Animation animation)`
`void`	`setAnimationMatrix(Matrix matrix)`
`void`	`setAutoHandwritingEnabled(boolean enabled)`
`void`	`setAutofillHints(String[] autofillHints)`
`void`	`setAutofillId(AutofillId id)`
`void`	`setBackground(Drawable background)`
`void`	`setBackgroundColor(int color)`
`void`	`setBackgroundDrawable(Drawable background)` This method is deprecated.
`void`	`setBackgroundResource(int resid)`
`void`	`setBackgroundTintBlendMode(BlendMode blendMode)`
`void`	`setBackgroundTintList(ColorStateList tint)`
`void`	`setBackgroundTintMode(PorterDuff.Mode tintMode)`
`final void`	`setBottom(int bottom)`
`void`	`setCameraDistance(float distance)`
`void`	`setClickable(boolean clickable)`
`void`	`setClipBounds(Rect clipBounds)`
`void`	`setClipToOutline(boolean clipToOutline)`
`void`	`setContentCaptureSession(ContentCaptureSession contentCaptureSession)`
`void`	`setContentDescription(CharSequence contentDescription)`
`final void`	`setContentSensitivity(int mode)`
`void`	`setContextClickable(boolean contextClickable)`
`void`	`setDefaultFocusHighlightEnabled(boolean defaultFocusHighlightEnabled)`
`void`	`setDrawingCacheBackgroundColor(int color)` This method is deprecated.
`void`	`setDrawingCacheEnabled(boolean enabled)` This method is deprecated.
`void`	`setDrawingCacheQuality(int quality)` This method is deprecated.
`void`	`setDuplicateParentStateEnabled(boolean enabled)`
`void`	`setElevation(float elevation)`
`void`	`setEnabled(boolean enabled)`
`void`	`setFadingEdgeLength(int length)`
`void`	`setFilterTouchesWhenObscured(boolean enabled)`
`void`	`setFitsSystemWindows(boolean fitSystemWindows)`
`void`	`setFocusable(boolean focusable)`
`void`	`setFocusableInTouchMode(boolean focusableInTouchMode)`
`void`	`setFocusedByDefault(boolean isFocusedByDefault)`
`void`	`setForceDarkAllowed(boolean allow)`
`void`	`setForeground(Drawable foreground)`
`void`	`setForegroundGravity(int gravity)`
`void`	`setForegroundTintBlendMode(BlendMode blendMode)`
`void`	`setForegroundTintList(ColorStateList tint)`
`void`	`setForegroundTintMode(PorterDuff.Mode tintMode)`
`void`	`setFrameContentVelocity(float pixelsPerSecond)`
`void`	`setHandwritingBoundsOffsets( float offsetLeft, float offsetTop, float offsetRight, float offsetBottom )`
`void`	`setHandwritingDelegateFlags(int flags)`
`void`	`setHandwritingDelegatorCallback(Runnable callback)`
`void`	`setHapticFeedbackEnabled(boolean hapticFeedbackEnabled)`
`void`	`setHasTransientState(boolean hasTransientState)`
`void`	`setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled)`
`void`	`setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled)`
`void`	`setHorizontalScrollbarThumbDrawable(Drawable drawable)`
`void`	`setHorizontalScrollbarTrackDrawable(Drawable drawable)`
`void`	`setHovered(boolean hovered)`
`void`	`setId(int id)`
`void`	`setImportantForAccessibility(int mode)`
`void`	`setImportantForAutofill(int mode)`
`void`	`setImportantForContentCapture(int mode)`
`void`	`setIsCredential(boolean isCredential)`
`void`	`setIsHandwritingDelegate(boolean isHandwritingDelegate)`
`void`	`setKeepScreenOn(boolean keepScreenOn)`
`void`	`setKeyboardNavigationCluster(boolean isCluster)`
`void`	`setLabelFor(int id)`
`void`	`setLayerPaint(Paint paint)`
`void`	`setLayerType(int layerType, Paint paint)`
`void`	`setLayoutDirection(int layoutDirection)`
`void`	`setLayoutParams(ViewGroup.LayoutParams params)`
`final void`	`setLeft(int left)`
`final void`	`setLeftTopRightBottom(int left, int top, int right, int bottom)`
`void`	`setLongClickable(boolean longClickable)`
`final void`	`setMeasuredDimension(int measuredWidth, int measuredHeight)`
`void`	`setMinimumHeight(int minHeight)`
`void`	`setMinimumWidth(int minWidth)`
`void`	`setNestedScrollingEnabled(boolean enabled)`
`void`	`setNextClusterForwardId(int nextClusterForwardId)`
`void`	`setNextFocusDownId(int nextFocusDownId)`
`void`	`setNextFocusForwardId(int nextFocusForwardId)`
`void`	`setNextFocusLeftId(int nextFocusLeftId)`
`void`	`setNextFocusRightId(int nextFocusRightId)`
`void`	`setNextFocusUpId(int nextFocusUpId)`
`void`	`setOnApplyWindowInsetsListener( View.OnApplyWindowInsetsListener listener )`
`void`	`setOnCapturedPointerListener(View.OnCapturedPointerListener l)`
`void`	`setOnClickListener(View.OnClickListener l)`
`void`	`setOnContextClickListener(View.OnContextClickListener l)`
`void`	`setOnCreateContextMenuListener(View.OnCreateContextMenuListener l)`
`void`	`setOnDragListener(View.OnDragListener l)`
`void`	`setOnFocusChangeListener(View.OnFocusChangeListener l)`
`void`	`setOnGenericMotionListener(View.OnGenericMotionListener l)`
`void`	`setOnHoverListener(View.OnHoverListener l)`
`void`	`setOnKeyListener(View.OnKeyListener l)`
`void`	`setOnLongClickListener(View.OnLongClickListener l)`
`void`	`setOnReceiveContentListener( String[] mimeTypes, OnReceiveContentListener listener )`
`void`	`setOnScrollChangeListener(View.OnScrollChangeListener l)`
`void`	`setOnSystemUiVisibilityChangeListener( View.OnSystemUiVisibilityChangeListener l )` This method is deprecated.
`void`	`setOnTouchListener(View.OnTouchListener l)`
`void`	`setOutlineAmbientShadowColor(int color)`
`void`	`setOutlineProvider(ViewOutlineProvider provider)`
`void`	`setOutlineSpotShadowColor(int color)`
`void`	`setOverScrollMode(int overScrollMode)`
`void`	`setPadding(int left, int top, int right, int bottom)`
`void`	`setPaddingRelative(int start, int top, int end, int bottom)`
`void`	`setPendingCredentialRequest( GetCredentialRequest request, OutcomeReceiver<GetCredentialResponse, GetCredentialException> callback )`
`void`	`setPivotX(float pivotX)`
`void`	`setPivotY(float pivotY)`
`void`	`setPointerIcon(PointerIcon pointerIcon)`
`final void`	`setPreferKeepClear(boolean preferKeepClear)`
`final void`	`setPreferKeepClearRects(List<Rect> rects)`
`void`	`setPressed(boolean pressed)`
`void`	`setRenderEffect(RenderEffect renderEffect)`
`final void`	`setRevealOnFocusHint(boolean revealOnFocus)`
`final void`	`setRight(int right)`
`void`	`setRotation(float rotation)`
`void`	`setRotationX(float rotationX)`
`void`	`setRotationY(float rotationY)`
`void`	`setSaveEnabled(boolean enabled)`
`void`	`setSaveFromParentEnabled(boolean enabled)`
`void`	`setScaleX(float scaleX)`
`void`	`setScaleY(float scaleY)`
`void`	`setScreenReaderFocusable(boolean screenReaderFocusable)`
`void`	`setScrollBarDefaultDelayBeforeFade( int scrollBarDefaultDelayBeforeFade )`
`void`	`setScrollBarFadeDuration(int scrollBarFadeDuration)`
`void`	`setScrollBarSize(int scrollBarSize)`
`void`	`setScrollBarStyle(int style)`
`final void`	`setScrollCaptureCallback(ScrollCaptureCallback callback)`
`void`	`setScrollCaptureHint(int hint)`
`void`	`setScrollContainer(boolean isScrollContainer)`
`void`	`setScrollIndicators(int indicators)`
`void`	`setScrollX(int value)`
`void`	`setScrollY(int value)`
`void`	`setScrollbarFadingEnabled(boolean fadeScrollbars)`
`void`	`setSelected(boolean selected)`
`void`	`setSoundEffectsEnabled(boolean soundEffectsEnabled)`
`void`	`setStateDescription(CharSequence stateDescription)`
`void`	`setStateListAnimator(StateListAnimator stateListAnimator)`
`void`	`setSupplementalDescription(CharSequence supplementalDescription)`
`void`	`setSystemGestureExclusionRects(List<Rect> rects)`
`void`	`setSystemUiVisibility(int visibility)` This method is deprecated.
`void`	`setTag(int key, Object tag)`
`void`	`setTextAlignment(int textAlignment)`
`void`	`setTextDirection(int textDirection)`
`void`	`setTooltipText(CharSequence tooltipText)`
`final void`	`setTop(int top)`
`void`	`setTouchDelegate(TouchDelegate delegate)`
`void`	`setTransitionAlpha(float alpha)`
`final void`	`setTransitionName(String transitionName)`
`void`	`setTransitionVisibility(int visibility)`
`void`	`setTranslationX(float translationX)`
`void`	`setTranslationY(float translationY)`
`void`	`setTranslationZ(float translationZ)`
`void`	`setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled)`
`void`	`setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled)`
`void`	`setVerticalScrollbarPosition(int position)`
`void`	`setVerticalScrollbarThumbDrawable(Drawable drawable)`
`void`	`setVerticalScrollbarTrackDrawable(Drawable drawable)`
`void`	`setViewTranslationCallback(ViewTranslationCallback callback)`
`void`	`setVisibility(int visibility)`
`void`	`setWillNotCacheDrawing(boolean willNotCacheDrawing)` This method is deprecated.
`void`	`setWillNotDraw(boolean willNotDraw)`
`void`	`setX(float x)`
`void`	`setY(float y)`
`void`	`setZ(float z)`
`boolean`	`showContextMenu()`
`ActionMode`	`startActionMode(ActionMode.Callback callback)`
`void`	`startAnimation(Animation animation)`
`final boolean`	`startDrag( ClipData data, View.DragShadowBuilder shadowBuilder, Object myLocalState, int flags )` This method is deprecated.
`final boolean`	`startDragAndDrop( ClipData data, View.DragShadowBuilder shadowBuilder, Object myLocalState, int flags )`
`boolean`	`startNestedScroll(int axes)`
`void`	`stopNestedScroll()`
`String`	`toString()`
`void`	`transformMatrixToGlobal(Matrix matrix)`
`void`	`transformMatrixToLocal(Matrix matrix)`
`void`	`unscheduleDrawable(Drawable who)`
`final void`	`updateDragShadow(View.DragShadowBuilder shadowBuilder)`
`boolean`	`verifyDrawable(Drawable who)`
`boolean`	`willNotCacheDrawing()` This method is deprecated.
`boolean`	`willNotDraw()`

From android.view.ViewGroup

`void`	`addChildrenForAccessibility(ArrayList<View> outChildren)`
`void`	`addExtraDataToAccessibilityNodeInfo( AccessibilityNodeInfo info, String extraDataKey, Bundle arguments )`
`void`	`addKeyboardNavigationClusters(Collection<View> views, int direction)`
`boolean`	`addStatesFromChildren()`
`void`	`addTouchables(ArrayList<View> views)`
`void`	`addView(View child)`
`boolean`	`addViewInLayout(View child, int index, ViewGroup.LayoutParams params)`
`void`	`attachLayoutAnimationParameters( View child, ViewGroup.LayoutParams params, int index, int count )`
`void`	`attachViewToParent(View child, int index, ViewGroup.LayoutParams params)`
`void`	`bringChildToFront(View child)`
`boolean`	`canAnimate()`
`void`	`childDrawableStateChanged(View child)`
`void`	`childHasTransientStateChanged( View child, boolean childHasTransientState )`
`void`	`cleanupLayoutState(View child)`
`void`	`clearChildFocus(View child)`
`void`	`clearDisappearingChildren()`
`void`	`clearFocus()`
`void`	`debug(int depth)`
`void`	`detachAllViewsFromParent()`
`void`	`detachViewFromParent(View child)`
`void`	`detachViewsFromParent(int start, int count)`
`WindowInsets`	`dispatchApplyWindowInsets(WindowInsets insets)`
`boolean`	`dispatchCapturedPointerEvent(MotionEvent event)`
`void`	`dispatchConfigurationChanged(Configuration newConfig)`
`void`	`dispatchCreateViewTranslationRequest( Map<AutofillId, long[]> viewIds, int[] supportedFormats, TranslationCapability capability, List<ViewTranslationRequest> requests )`
`void`	`dispatchDisplayHint(int hint)`
`boolean`	`dispatchDragEvent(DragEvent event)`
`void`	`dispatchDraw(Canvas canvas)`
`void`	`dispatchDrawableHotspotChanged(float x, float y)`
`void`	`dispatchFinishTemporaryDetach()`
`void`	`dispatchFreezeSelfOnly(SparseArray<Parcelable> container)`
`boolean`	`dispatchGenericFocusedEvent(MotionEvent event)`
`boolean`	`dispatchGenericPointerEvent(MotionEvent event)`
`boolean`	`dispatchHoverEvent(MotionEvent event)`
`boolean`	`dispatchKeyEvent(KeyEvent event)`
`boolean`	`dispatchKeyEventPreIme(KeyEvent event)`
`boolean`	`dispatchKeyShortcutEvent(KeyEvent event)`
`void`	`dispatchPointerCaptureChanged(boolean hasCapture)`
`void`	`dispatchProvideAutofillStructure(ViewStructure structure, int flags)`
`void`	`dispatchProvideStructure(ViewStructure structure)`
`void`	`dispatchRestoreInstanceState(SparseArray<Parcelable> container)`
`void`	`dispatchSaveInstanceState(SparseArray<Parcelable> container)`
`void`	`dispatchScrollCaptureSearch( Rect localVisibleRect, Point windowOffset, Consumer<ScrollCaptureTarget> targets )`
`void`	`dispatchSetActivated(boolean activated)`
`void`	`dispatchSetPressed(boolean pressed)`
`void`	`dispatchSetSelected(boolean selected)`
`void`	`dispatchStartTemporaryDetach()`
`void`	`dispatchSystemUiVisibilityChanged(int visible)` This method is deprecated.
`void`	`dispatchThawSelfOnly(SparseArray<Parcelable> container)`
`boolean`	`dispatchTouchEvent(MotionEvent ev)`
`boolean`	`dispatchTrackballEvent(MotionEvent event)`
`boolean`	`dispatchUnhandledMove(View focused, int direction)`
`void`	`dispatchVisibilityChanged(View changedView, int visibility)`
`void`	`dispatchWindowFocusChanged(boolean hasFocus)`
`void`	`dispatchWindowInsetsAnimationEnd(WindowInsetsAnimation animation)`
`void`	`dispatchWindowInsetsAnimationPrepare(WindowInsetsAnimation animation)`
`WindowInsets`	`dispatchWindowInsetsAnimationProgress( WindowInsets insets, List<WindowInsetsAnimation> runningAnimations )`
`WindowInsetsAnimation.Bounds`	`dispatchWindowInsetsAnimationStart( WindowInsetsAnimation animation, WindowInsetsAnimation.Bounds bounds )`
`void`	`dispatchWindowSystemUiVisiblityChanged(int visible)` This method is deprecated.
`void`	`dispatchWindowVisibilityChanged(int visibility)`
`void`	`drawableStateChanged()`
`void`	`endViewTransition(View view)`
`View`	`findFocus()`
`OnBackInvokedDispatcher`	`findOnBackInvokedDispatcherForChild(View child, View requester)`
`void`	`findViewsWithText( ArrayList<View> outViews, CharSequence text, int flags )`
`View`	`focusSearch(View focused, int direction)`
`void`	`focusableViewAvailable(View v)`
`boolean`	`gatherTransparentRegion(Region region)`
`CharSequence`	`getAccessibilityClassName()`
`View`	`getChildAt(int index)`
`int`	`getChildCount()`
`final int`	`getChildDrawingOrder(int drawingPosition)`
`static int`	`getChildMeasureSpec(int spec, int padding, int childDimension)`
`boolean`	`getChildStaticTransformation(View child, Transformation t)`
`boolean`	`getChildVisibleRect(View child, Rect r, Point offset)`
`boolean`	`getClipChildren()`
`boolean`	`getClipToPadding()`
`int`	`getDescendantFocusability()`
`View`	`getFocusedChild()`
`LayoutAnimationController`	`getLayoutAnimation()`
`Animation.AnimationListener`	`getLayoutAnimationListener()`
`int`	`getLayoutMode()`
`LayoutTransition`	`getLayoutTransition()`
`int`	`getNestedScrollAxes()`
`ViewGroupOverlay`	`getOverlay()`
`int`	`getPersistentDrawingCache()` This method is deprecated.
`boolean`	`getTouchscreenBlocksFocus()`
`boolean`	`hasFocus()`
`boolean`	`hasTransientState()`
`int`	`indexOfChild(View child)`
`final void`	`invalidateChild(View child, Rect dirty)` This method is deprecated.
`ViewParent`	`invalidateChildInParent(int[] location, Rect dirty)` This method is deprecated.
`boolean`	`isAlwaysDrawnWithCacheEnabled()` This method is deprecated.
`boolean`	`isAnimationCacheEnabled()` This method is deprecated.
`boolean`	`isChildrenDrawingOrderEnabled()`
`boolean`	`isChildrenDrawnWithCacheEnabled()` This method is deprecated.
`boolean`	`isLayoutSuppressed()`
`boolean`	`isMotionEventSplittingEnabled()`
`boolean`	`isTransitionGroup()`
`void`	`jumpDrawablesToCurrentState()`
`final void`	`layout(int l, int t, int r, int b)`
`void`	`measureChild( View child, int parentWidthMeasureSpec, int parentHeightMeasureSpec )`
`void`	`measureChildWithMargins( View child, int parentWidthMeasureSpec, int widthUsed, int parentHeightMeasureSpec, int heightUsed )`
`void`	`measureChildren(int widthMeasureSpec, int heightMeasureSpec)`
`void`	`notifySubtreeAccessibilityStateChanged( View child, View source, int changeType )`
`final void`	`offsetDescendantRectToMyCoords(View descendant, Rect rect)`
`final void`	`offsetRectIntoDescendantCoords(View descendant, Rect rect)`
`int[]`	`onCreateDrawableState(int extraSpace)`
`void`	`onDescendantInvalidated(View child, View target)`
`boolean`	`onInterceptHoverEvent(MotionEvent event)`
`boolean`	`onNestedFling( View target, float velocityX, float velocityY, boolean consumed )`
`boolean`	`onNestedPreFling(View target, float velocityX, float velocityY)`
`boolean`	`onNestedPrePerformAccessibilityAction( View target, int action, Bundle args )`
`void`	`onNestedPreScroll(View target, int dx, int dy, int[] consumed)`
`void`	`onNestedScroll( View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed )`
`void`	`onNestedScrollAccepted(View child, View target, int axes)`
`boolean`	`onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect)`
`boolean`	`onRequestSendAccessibilityEvent(View child, AccessibilityEvent event)`
`PointerIcon`	`onResolvePointerIcon(MotionEvent event, int pointerIndex)`
`boolean`	`onStartNestedScroll(View child, View target, int nestedScrollAxes)`
`void`	`onStopNestedScroll(View child)`
`void`	`onViewAdded(View child)`
`void`	`onViewRemoved(View child)`
`void`	`propagateRequestedFrameRate(float frameRate, boolean forceOverride)`
`void`	`recomputeViewAttributes(View child)`
`void`	`removeAllViews()`
`void`	`removeAllViewsInLayout()`
`void`	`removeDetachedView(View child, boolean animate)`
`void`	`removeView(View view)`
`void`	`removeViewAt(int index)`
`void`	`removeViewInLayout(View view)`
`void`	`removeViews(int start, int count)`
`void`	`removeViewsInLayout(int start, int count)`
`void`	`requestChildFocus(View child, View focused)`
`boolean`	`requestChildRectangleOnScreen( View child, Rect rectangle, boolean immediate )`
`boolean`	`requestFocus(int direction, Rect previouslyFocusedRect)`
`boolean`	`requestSendAccessibilityEvent(View child, AccessibilityEvent event)`
`void`	`requestTransparentRegion(View child)`
`boolean`	`restoreDefaultFocus()`
`void`	`scheduleLayoutAnimation()`
`void`	`setAddStatesFromChildren(boolean addsStates)`
`void`	`setAlwaysDrawnWithCacheEnabled(boolean always)` This method is deprecated.
`void`	`setAnimationCacheEnabled(boolean enabled)` This method is deprecated.
`void`	`setChildrenDrawingCacheEnabled(boolean enabled)` This method is deprecated.
`void`	`setChildrenDrawingOrderEnabled(boolean enabled)`
`void`	`setChildrenDrawnWithCacheEnabled(boolean enabled)` This method is deprecated.
`void`	`setClipChildren(boolean clipChildren)`
`void`	`setClipToPadding(boolean clipToPadding)`
`void`	`setDescendantFocusability(int focusability)`
`void`	`setLayoutAnimation(LayoutAnimationController controller)`
`void`	`setLayoutAnimationListener( Animation.AnimationListener animationListener )`
`void`	`setLayoutMode(int layoutMode)`
`void`	`setLayoutTransition(LayoutTransition transition)`
`void`	`setMotionEventSplittingEnabled(boolean split)`
`void`	`setOnHierarchyChangeListener( ViewGroup.OnHierarchyChangeListener listener )`
`void`	`setPersistentDrawingCache(int drawingCacheToKeep)` This method is deprecated.
`void`	`setRequestedFrameRate(float frameRate)`
`void`	`setStaticTransformationsEnabled(boolean enabled)`
`void`	`setTouchscreenBlocksFocus(boolean touchscreenBlocksFocus)`
`void`	`setTransitionGroup(boolean isTransitionGroup)`
`void`	`setWindowInsetsAnimationCallback( WindowInsetsAnimation.Callback callback )`
`boolean`	`shouldDelayChildPressedState()`
`boolean`	`showContextMenuForChild(View originalView)`
`ActionMode`	`startActionModeForChild( View originalView, ActionMode.Callback callback )`
`void`	`startLayoutAnimation()`
`void`	`startViewTransition(View view)`
`void`	`suppressLayout(boolean suppress)`
`void`	`updateViewLayout(View view, ViewGroup.LayoutParams params)`

Constants

LOCK_MODE_LOCKED_CLOSED

Added in 1.0.0

public static final int LOCK_MODE_LOCKED_CLOSED = 1

The drawer is locked closed. The user may not open it, though the app may open it programmatically.

LOCK_MODE_LOCKED_OPEN

Added in 1.0.0

public static final int LOCK_MODE_LOCKED_OPEN = 2

The drawer is locked open. The user may not close it, though the app may close it programmatically.

LOCK_MODE_UNDEFINED

Added in 1.0.0

public static final int LOCK_MODE_UNDEFINED = 3

The drawer's lock state is reset to default.

LOCK_MODE_UNLOCKED

Added in 1.0.0

public static final int LOCK_MODE_UNLOCKED = 0

The drawer is unlocked.

STATE_DRAGGING

Added in 1.0.0

public static final int STATE_DRAGGING = 1

Indicates that a drawer is currently being dragged by the user.

STATE_IDLE

Added in 1.0.0

public static final int STATE_IDLE = 0

Indicates that any drawers are in an idle, settled state. No animation is in progress.

STATE_SETTLING

Added in 1.0.0

public static final int STATE_SETTLING = 2

Indicates that a drawer is in the process of settling to a final position.

Public constructors

DrawerLayout

Added in 1.0.0

public DrawerLayout(@NonNull Context context)

DrawerLayout

Added in 1.0.0

public DrawerLayout(@NonNull Context context, @Nullable AttributeSet attrs)

DrawerLayout

Added in 1.0.0

public DrawerLayout(
    @NonNull Context context,
    @Nullable AttributeSet attrs,
    int defStyleAttr
)

Public methods

Added in 1.0.0

public void addDrawerListener(@NonNull DrawerLayout.DrawerListener listener)

Adds the specified listener to the list of listeners that will be notified of drawer events.

Parameters
`@NonNull DrawerLayout.DrawerListener listener`	Listener to notify when drawer events occur.

See also
`removeDrawerListener`

addFocusables

public void addFocusables(ArrayList<View> views, int direction, int focusableMode)

addView

public void addView(View child, int index, ViewGroup.LayoutParams params)

close

Added in 1.1.0

public void close()

Close the START drawer by animating it out of view.

closeDrawer

Added in 1.0.0

public void closeDrawer(@NonNull View drawerView)

Close the specified drawer view by animating it into view.

Parameters
`@NonNull View drawerView`	Drawer view to close

closeDrawer

Added in 1.0.0

public void closeDrawer(int gravity)

Close the specified drawer by animating it out of view.

Parameters
`int gravity`	Gravity.LEFT to move the left drawer or Gravity.RIGHT for the right. GravityCompat.START or GravityCompat.END may also be used.

closeDrawer

Added in 1.0.0

public void closeDrawer(@NonNull View drawerView, boolean animate)

Close the specified drawer view.

Parameters
`@NonNull View drawerView`	Drawer view to close
`boolean animate`	Whether closing of the drawer should be animated.

closeDrawer

Added in 1.0.0

public void closeDrawer(int gravity, boolean animate)

Close the specified drawer.

Parameters
`int gravity`	Gravity.LEFT to move the left drawer or Gravity.RIGHT for the right. GravityCompat.START or GravityCompat.END may also be used.
`boolean animate`	Whether closing of the drawer should be animated.

closeDrawers

Added in 1.0.0

public void closeDrawers()

Close all currently open drawer views by animating them out of view.

computeScroll

public void computeScroll()

dispatchGenericMotionEvent

public boolean dispatchGenericMotionEvent(MotionEvent event)

generateLayoutParams

public ViewGroup.LayoutParams generateLayoutParams(AttributeSet attrs)

getDrawerElevation

Added in 1.0.0

public float getDrawerElevation()

The base elevation of the drawer(s) relative to the parent, in pixels. Note that the elevation change is only supported in API 21 and above. For unsupported API levels, 0 will be returned as the elevation.

Returns
`float`	The base depth position of the view, in pixels.

getDrawerLockMode

Added in 1.0.0

public int getDrawerLockMode(@NonNull View drawerView)

Check the lock mode of the given drawer view.

Parameters
`@NonNull View drawerView`	Drawer view to check lock mode

Returns
`int`	one of `LOCK_MODE_UNLOCKED`, `LOCK_MODE_LOCKED_CLOSED` or `LOCK_MODE_LOCKED_OPEN`.

getDrawerLockMode

Added in 1.0.0

public int getDrawerLockMode(int edgeGravity)

Check the lock mode of the drawer with the given gravity.

Parameters
`int edgeGravity`	Gravity of the drawer to check

Returns
`int`	one of `LOCK_MODE_UNLOCKED`, `LOCK_MODE_LOCKED_CLOSED` or `LOCK_MODE_LOCKED_OPEN`.

getDrawerTitle

Added in 1.0.0

public @Nullable CharSequence getDrawerTitle(int edgeGravity)

Returns the title of the drawer with the given gravity.

Parameters
`int edgeGravity`	Gravity.LEFT, RIGHT, START or END. Expresses which drawer to return the title for.

Returns
`@Nullable CharSequence`	The title of the drawer, or null if none set.

See also
`setDrawerTitle`

getStatusBarBackgroundDrawable

Added in 1.0.0

public @Nullable Drawable getStatusBarBackgroundDrawable()

Gets the drawable used to draw in the insets area for the status bar.

Returns
`@Nullable Drawable`	The status bar background drawable, or null if none set

isDrawerOpen

Added in 1.0.0

public boolean isDrawerOpen(int drawerGravity)

Check if the given drawer view is currently in an open state. To be considered "open" the drawer must have settled into its fully visible state. If there is no drawer with the given gravity this method will return false.

Parameters
`int drawerGravity`	Gravity of the drawer to check

Returns
`boolean`	true if the given drawer view is in an open state

isDrawerOpen

Added in 1.0.0

public boolean isDrawerOpen(@NonNull View drawer)

Check if the given drawer view is currently in an open state. To be considered "open" the drawer must have settled into its fully visible state. To check for partial visibility use isDrawerVisible.

Parameters
`@NonNull View drawer`	Drawer view to check

Returns
`boolean`	true if the given drawer view is in an open state

See also
`isDrawerVisible`

isDrawerVisible

Added in 1.0.0

public boolean isDrawerVisible(int drawerGravity)

Check if a given drawer view is currently visible on-screen. The drawer may be only peeking onto the screen, fully extended, or anywhere in between. If there is no drawer with the given gravity this method will return false.

Parameters
`int drawerGravity`	Gravity of the drawer to check

Returns
`boolean`	true if the given drawer is visible on-screen

isDrawerVisible

Added in 1.0.0

public boolean isDrawerVisible(@NonNull View drawer)

Check if a given drawer view is currently visible on-screen. The drawer may be only peeking onto the screen, fully extended, or anywhere inbetween.

Parameters
`@NonNull View drawer`	Drawer view to check

Returns
`boolean`	true if the given drawer is visible on-screen

See also
`isDrawerOpen`

isOpen

Added in 1.1.0

public boolean isOpen()

Check if the START drawer is currently in an open state. To be considered "open" the drawer must have settled into its fully visible state. If there is no drawer with the given gravity this method will return false.

Returns
`boolean`	true if the `START` drawer is in an open state

onDraw

Added in 1.0.0

public void onDraw(@NonNull Canvas c)

onInterceptTouchEvent

public boolean onInterceptTouchEvent(MotionEvent ev)

onKeyDown

public boolean onKeyDown(int keyCode, KeyEvent event)

onKeyUp

public boolean onKeyUp(int keyCode, KeyEvent event)

onRtlPropertiesChanged

public void onRtlPropertiesChanged(int layoutDirection)

onTouchEvent

public boolean onTouchEvent(MotionEvent ev)

open

Added in 1.1.0

public void open()

Open the START drawer by animating it into view.

openDrawer

Added in 1.0.0

public void openDrawer(@NonNull View drawerView)

Open the specified drawer view by animating it into view.

Parameters
`@NonNull View drawerView`	Drawer view to open

openDrawer

Added in 1.0.0

public void openDrawer(int gravity)

Open the specified drawer by animating it out of view.

Parameters
`int gravity`	Gravity.LEFT to move the left drawer or Gravity.RIGHT for the right. GravityCompat.START or GravityCompat.END may also be used.

openDrawer

Added in 1.0.0

public void openDrawer(@NonNull View drawerView, boolean animate)

Open the specified drawer view.

Parameters
`@NonNull View drawerView`	Drawer view to open
`boolean animate`	Whether opening of the drawer should be animated.

openDrawer

Added in 1.0.0

public void openDrawer(int gravity, boolean animate)

Open the specified drawer.

Parameters
`int gravity`	Gravity.LEFT to move the left drawer or Gravity.RIGHT for the right. GravityCompat.START or GravityCompat.END may also be used.
`boolean animate`	Whether opening of the drawer should be animated.

Added in 1.0.0

public void removeDrawerListener(@NonNull DrawerLayout.DrawerListener listener)

Removes the specified listener from the list of listeners that will be notified of drawer events.

Parameters
`@NonNull DrawerLayout.DrawerListener listener`	Listener to remove from being notified of drawer events

See also
`addDrawerListener`

requestDisallowInterceptTouchEvent

public void requestDisallowInterceptTouchEvent(boolean disallowIntercept)

requestLayout

public void requestLayout()

setDrawerElevation

Added in 1.0.0

public void setDrawerElevation(float elevation)

Sets the base elevation of the drawer(s) relative to the parent, in pixels. Note that the elevation change is only supported in API 21 and above.

Parameters
`float elevation`	The base depth position of the view, in pixels.

Added in 1.0.0

Deprecated in 1.0.0

public void setDrawerListener(DrawerLayout.DrawerListener listener)

Set a listener to be notified of drawer events. Note that this method is deprecated and you should use addDrawerListener to add a listener and removeDrawerListener to remove a registered listener.

Parameters
`DrawerLayout.DrawerListener listener`	Listener to notify when drawer events occur

See also
`DrawerLayout.DrawerListener`
`addDrawerListener`
`removeDrawerListener`

setDrawerLockMode

Added in 1.0.0

public void setDrawerLockMode(int lockMode)

Enable or disable interaction with all drawers.

This allows the application to restrict the user's ability to open or close any drawer within this layout. DrawerLayout will still respond to calls to openDrawer, closeDrawer and friends if a drawer is locked.

Locking drawers open or closed will implicitly open or close any drawers as appropriate.

Parameters
`int lockMode`	The new lock mode for the given drawer. One of `LOCK_MODE_UNLOCKED`, `LOCK_MODE_LOCKED_CLOSED` or `LOCK_MODE_LOCKED_OPEN`.

setDrawerLockMode

Added in 1.0.0

public void setDrawerLockMode(int lockMode, @NonNull View drawerView)

Enable or disable interaction with the given drawer.

This allows the application to restrict the user's ability to open or close the given drawer. DrawerLayout will still respond to calls to openDrawer, closeDrawer and friends if a drawer is locked.

Locking a drawer open or closed will implicitly open or close that drawer as appropriate.

Parameters
`int lockMode`	The new lock mode for the given drawer. One of `LOCK_MODE_UNLOCKED`, `LOCK_MODE_LOCKED_CLOSED` or `LOCK_MODE_LOCKED_OPEN`.
`@NonNull View drawerView`	The drawer view to change the lock mode for

See also
`LOCK_MODE_UNLOCKED`
`LOCK_MODE_LOCKED_CLOSED`
`LOCK_MODE_LOCKED_OPEN`

setDrawerLockMode

Added in 1.0.0

public void setDrawerLockMode(int lockMode, int edgeGravity)

Enable or disable interaction with the given drawer.

Locking a drawer open or closed will implicitly open or close that drawer as appropriate.

Parameters
`int lockMode`	The new lock mode for the given drawer. One of `LOCK_MODE_UNLOCKED`, `LOCK_MODE_LOCKED_CLOSED` or `LOCK_MODE_LOCKED_OPEN`.
`int edgeGravity`	Gravity.LEFT, RIGHT, START or END. Expresses which drawer to change the mode for.

See also
`LOCK_MODE_UNLOCKED`
`LOCK_MODE_LOCKED_CLOSED`
`LOCK_MODE_LOCKED_OPEN`

setDrawerShadow

Added in 1.0.0

public void setDrawerShadow(@DrawableRes int resId, int gravity)

Set a simple drawable used for the left or right shadow. The drawable provided must have a nonzero intrinsic width. For API 21 and above, an elevation will be set on the drawer instead of using the provided shadow drawable.

Note that for better support for both left-to-right and right-to-left layout directions, a drawable for RTL layout (in additional to the one in LTR layout) can be defined with a resource qualifier "ldrtl" for API 17 and above with the gravity START. Alternatively, for API 23 and above, the drawable can auto-mirrored such that the drawable will be mirrored in RTL layout.

Parameters
`@DrawableRes int resId`	Resource id of a shadow drawable to use at the edge of a drawer
`int gravity`	Which drawer the shadow should apply to

setDrawerShadow

Added in 1.0.0

public void setDrawerShadow(@Nullable Drawable shadowDrawable, int gravity)

Parameters
`@Nullable Drawable shadowDrawable`	Shadow drawable to use at the edge of a drawer
`int gravity`	Which drawer the shadow should apply to

setDrawerTitle

Added in 1.0.0

public void setDrawerTitle(int edgeGravity, @Nullable CharSequence title)

Sets the title of the drawer with the given gravity.

When accessibility is turned on, this is the title that will be used to identify the drawer to the active accessibility service.

Parameters
`int edgeGravity`	Gravity.LEFT, RIGHT, START or END. Expresses which drawer to set the title for.
`@Nullable CharSequence title`	The title for the drawer.

setScrimColor

Added in 1.0.0

public void setScrimColor(@ColorInt int color)

Set a color to use for the scrim that obscures primary content while a drawer is open.

Parameters
`@ColorInt int color`	Color to use in 0xAARRGGBB format.

setStatusBarBackground

Added in 1.0.0

public void setStatusBarBackground(@Nullable Drawable bg)

Set a drawable to draw in the insets area for the status bar. Note that this will only be activated if this DrawerLayout fitsSystemWindows.

Parameters
`@Nullable Drawable bg`	Background drawable to draw behind the status bar

setStatusBarBackground

Added in 1.0.0

public void setStatusBarBackground(int resId)

Set a drawable to draw in the insets area for the status bar. Note that this will only be activated if this DrawerLayout fitsSystemWindows.

Parameters
`int resId`	Resource id of a background drawable to draw behind the status bar

setStatusBarBackgroundColor

Added in 1.0.0

public void setStatusBarBackgroundColor(@ColorInt int color)

Set a drawable to draw in the insets area for the status bar. Note that this will only be activated if this DrawerLayout fitsSystemWindows.

Parameters
`@ColorInt int color`	Color to use as a background drawable to draw behind the status bar in 0xAARRGGBB format.

Protected methods

checkLayoutParams

protected boolean checkLayoutParams(ViewGroup.LayoutParams p)

drawChild

protected boolean drawChild(@NonNull Canvas canvas, View child, long drawingTime)

generateDefaultLayoutParams

protected ViewGroup.LayoutParams generateDefaultLayoutParams()

generateLayoutParams

protected ViewGroup.LayoutParams generateLayoutParams(ViewGroup.LayoutParams p)

onAttachedToWindow

protected void onAttachedToWindow()

onDetachedFromWindow

protected void onDetachedFromWindow()

onLayout

protected void onLayout(boolean changed, int l, int t, int r, int b)

onMeasure

protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec)

onRestoreInstanceState

protected void onRestoreInstanceState(Parcelable state)

onSaveInstanceState

protected @NonNull Parcelable onSaveInstanceState()

DrawerLayout

Summary

Nested types

Constants

Public constructors

Public methods

Protected methods

Inherited Constants

Inherited methods

Constants

LOCK_MODE_LOCKED_CLOSED

LOCK_MODE_LOCKED_OPEN

LOCK_MODE_UNDEFINED

LOCK_MODE_UNLOCKED

STATE_DRAGGING

STATE_IDLE

STATE_SETTLING

Public constructors

DrawerLayout

DrawerLayout

DrawerLayout

Public methods

addDrawerListener

addFocusables

addView

close

closeDrawer

closeDrawer

closeDrawer

closeDrawer

closeDrawers

computeScroll

dispatchGenericMotionEvent

generateLayoutParams

getDrawerElevation

getDrawerLockMode

getDrawerLockMode

getDrawerTitle

getStatusBarBackgroundDrawable

isDrawerOpen

isDrawerOpen

isDrawerVisible

isDrawerVisible

isOpen

onDraw

onInterceptTouchEvent

onKeyDown

onKeyUp

onRtlPropertiesChanged

onTouchEvent

open

openDrawer

openDrawer

openDrawer

openDrawer

removeDrawerListener

requestDisallowInterceptTouchEvent

requestLayout

setDrawerElevation

setDrawerListener

setDrawerLockMode

setDrawerLockMode

setDrawerLockMode

setDrawerShadow

setDrawerShadow

setDrawerTitle

setScrimColor

setStatusBarBackground

setStatusBarBackground

setStatusBarBackgroundColor

Protected methods

checkLayoutParams

drawChild

generateDefaultLayoutParams

generateLayoutParams

onAttachedToWindow

onDetachedFromWindow

onLayout

onMeasure

onRestoreInstanceState