appcompat/androidx.appcompat.app/ActionBarDrawerToggle

ActionBarDrawerToggle

open class ActionBarDrawerToggle : DrawerLayout.DrawerListener(source)

This class provides a handy way to tie together the functionality of DrawerLayout and the framework ActionBar to implement the recommended design for navigation drawers.

To use ActionBarDrawerToggle, create one in your Activity and call through to the following methods corresponding to your Activity callbacks:

Call syncState from your Activity's onPostCreate to synchronize the indicator with the state of the linked DrawerLayout after onRestoreInstanceState has occurred.

ActionBarDrawerToggle can be used directly as a DrawerLayout.DrawerListener, or if you are already providing your own listener, call through to each of the listener methods from your own.

You can customize the the animated toggle by defining the drawerArrowStyle in your ActionBar theme.

Constructors

ActionBarDrawerToggle

constructor(activity: Activity, drawerLayout: DrawerLayout, @StringRes openDrawerContentDescRes: Int, @StringRes closeDrawerContentDescRes: Int)

Construct a new ActionBarDrawerToggle.

constructor(activity: Activity, drawerLayout: DrawerLayout, toolbar: Toolbar, @StringRes openDrawerContentDescRes: Int, @StringRes closeDrawerContentDescRes: Int)

Construct a new ActionBarDrawerToggle with a Toolbar.

Types

interface Delegate

DelegateProvider

interface DelegateProvider

Allows an implementing Activity to return an ActionBarDrawerToggle.Delegate to use with ActionBarDrawerToggle.

Functions

getDrawerArrowDrawable

@NonNull

open fun getDrawerArrowDrawable(): @NonNull DrawerArrowDrawable

getToolbarNavigationClickListener

open fun getToolbarNavigationClickListener(): View.OnClickListener

Returns the fallback listener for Navigation icon click events.

isDrawerIndicatorEnabled

open fun isDrawerIndicatorEnabled(): Boolean

isDrawerSlideAnimationEnabled

open fun isDrawerSlideAnimationEnabled(): Boolean

onConfigurationChanged

open fun onConfigurationChanged(newConfig: Configuration)

This method should always be called by your Activity's onConfigurationChanged method.

open fun onDrawerClosed(drawerView: View)

DrawerLayout.DrawerListener callback method.

open fun onDrawerOpened(drawerView: View)

DrawerLayout.DrawerListener callback method.

open fun onDrawerSlide(drawerView: View, slideOffset: Float)

DrawerLayout.DrawerListener callback method.

onDrawerStateChanged

open fun onDrawerStateChanged(newState: Int)

DrawerLayout.DrawerListener callback method.

onOptionsItemSelected

open fun onOptionsItemSelected(item: MenuItem): Boolean

This method should be called by your Activity's onOptionsItemSelected method.

setDrawerArrowDrawable

open fun setDrawerArrowDrawable(@NonNull drawable: @NonNull DrawerArrowDrawable)

Sets the DrawerArrowDrawable that should be shown by this ActionBarDrawerToggle.

setDrawerIndicatorEnabled

open fun setDrawerIndicatorEnabled(enable: Boolean)

Enable or disable the drawer indicator.

setDrawerSlideAnimationEnabled

open fun setDrawerSlideAnimationEnabled(enabled: Boolean)

Specifies whether the drawer arrow should animate when the drawer position changes.

setHomeAsUpIndicator

open fun setHomeAsUpIndicator(indicator: Drawable)

open fun setHomeAsUpIndicator(resId: Int)

Set the up indicator to display when the drawer indicator is not enabled.

setToolbarNavigationClickListener

open fun setToolbarNavigationClickListener(onToolbarNavigationClickListener: View.OnClickListener)

When DrawerToggle is constructed with a Toolbar, it sets the click listener on the Navigation icon.

open fun syncState()

Synchronize the state of the drawer indicator/affordance with the linked DrawerLayout.