Summary: Nested Classes | Constants | Inherited Constants | Inherited Fields | Ctors | Methods | Protected Methods | Inherited Methods

DrawerLayout

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.

DrawerLayout.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. DrawerLayout.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 classes
interface	DrawerLayout.DrawerListener Listener for monitoring events about drawers.
class	DrawerLayout.LayoutParams
class	DrawerLayout.SavedState State persisted across instances
class	DrawerLayout.SimpleDrawerListener Stub/no-op implementations of all methods of DrawerLayout.DrawerListener.

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

Inherited constants
From class android.view.ViewGroup int CLIP_TO_PADDING_MASK int FOCUS_AFTER_DESCENDANTS int FOCUS_BEFORE_DESCENDANTS int FOCUS_BLOCK_DESCENDANTS int LAYOUT_MODE_CLIP_BOUNDS int LAYOUT_MODE_OPTICAL_BOUNDS int PERSISTENT_ALL_CACHES int PERSISTENT_ANIMATION_CACHE int PERSISTENT_NO_CACHE int PERSISTENT_SCROLLING_CACHE
From class android.view.View int ACCESSIBILITY_LIVE_REGION_ASSERTIVE int ACCESSIBILITY_LIVE_REGION_NONE int ACCESSIBILITY_LIVE_REGION_POLITE int AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR String AUTOFILL_HINT_CREDIT_CARD_NUMBER String AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE String AUTOFILL_HINT_EMAIL_ADDRESS String AUTOFILL_HINT_NAME String AUTOFILL_HINT_PASSWORD String AUTOFILL_HINT_PHONE String AUTOFILL_HINT_POSTAL_ADDRESS String AUTOFILL_HINT_POSTAL_CODE String AUTOFILL_HINT_USERNAME int AUTOFILL_TYPE_DATE int AUTOFILL_TYPE_LIST int AUTOFILL_TYPE_NONE int AUTOFILL_TYPE_TEXT int AUTOFILL_TYPE_TOGGLE int DRAG_FLAG_GLOBAL int DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION int DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION int DRAG_FLAG_GLOBAL_URI_READ int DRAG_FLAG_GLOBAL_URI_WRITE int DRAG_FLAG_OPAQUE int DRAWING_CACHE_QUALITY_AUTO int DRAWING_CACHE_QUALITY_HIGH int DRAWING_CACHE_QUALITY_LOW int FIND_VIEWS_WITH_CONTENT_DESCRIPTION int FIND_VIEWS_WITH_TEXT int FOCUSABLE int FOCUSABLES_ALL int FOCUSABLES_TOUCH_MODE int FOCUSABLE_AUTO