DrawerBuilder (library API)

java.lang.Object
- com.mikepenz.materialdrawer.DrawerBuilder

public class DrawerBuilder
extends java.lang.Object

Created by mikepenz on 23.05.15.

Field Summary

Fields
Modifier and Type	Field and Description
`protected AccountHeader`	`mAccountHeader`
`protected boolean`	`mAccountHeaderSticky`
`protected android.support.v7.app.ActionBarDrawerToggle`	`mActionBarDrawerToggle`
`protected boolean`	`mActionBarDrawerToggleEnabled`
`protected android.app.Activity`	`mActivity`
`protected com.mikepenz.fastadapter.FastAdapter<IDrawerItem>`	`mAdapter`
`protected android.support.v7.widget.RecyclerView.Adapter`	`mAdapterWrapper`
`protected boolean`	`mAnimateActionBarDrawerToggle`
`protected boolean`	`mAppended`
`protected boolean`	`mCloseOnClick`
`protected int`	`mCurrentStickyFooterSelection`
`protected android.view.View`	`mCustomView`
`protected int`	`mDelayDrawerClickEvent`
`protected int`	`mDelayOnDrawerClose`
`protected java.lang.Boolean`	`mDisplayBelowStatusBar`
`protected java.lang.Integer`	`mDrawerGravity`
`protected android.support.v4.widget.DrawerLayout`	`mDrawerLayout`
`protected int`	`mDrawerWidth`
`protected boolean`	`mFireInitialOnClick`
`protected com.mikepenz.fastadapter.adapters.FooterAdapter<IDrawerItem>`	`mFooterAdapter`
`protected boolean`	`mFooterClickable`
`protected boolean`	`mFooterDivider`
`protected android.view.View`	`mFooterView`
`protected boolean`	`mFullscreen`
`protected boolean`	`mGenerateMiniDrawer`
`protected boolean`	`mHasStableIds`
`protected com.mikepenz.fastadapter.adapters.HeaderAdapter<IDrawerItem>`	`mHeaderAdapter`
`protected boolean`	`mHeaderDivider`
`protected boolean`	`mHeaderPadding`
`protected android.view.View`	`mHeaderView`
`protected DimenHolder`	`mHeiderHeight`
`protected com.mikepenz.fastadapter.adapters.ItemAdapter<IDrawerItem>`	`mItemAdapter`
`protected android.support.v7.widget.RecyclerView.ItemAnimator`	`mItemAnimator`
`protected android.support.v7.widget.RecyclerView.LayoutManager`	`mLayoutManager`
`protected com.mikepenz.materialize.Materialize`	`mMaterialize`
`protected MiniDrawer`	`mMiniDrawer`
`protected boolean`	`mMultiSelect`
`protected Drawer.OnDrawerItemClickListener`	`mOnDrawerItemClickListener`
`protected Drawer.OnDrawerItemLongClickListener`	`mOnDrawerItemLongClickListener`
`protected Drawer.OnDrawerListener`	`mOnDrawerListener`
`protected Drawer.OnDrawerNavigationListener`	`mOnDrawerNavigationListener`
`protected boolean`	`mPositionBasedStateManagement`
`protected android.support.v7.widget.RecyclerView`	`mRecyclerView`
`protected android.view.ViewGroup`	`mRootView`
`protected android.os.Bundle`	`mSavedInstance`
`protected boolean`	`mScrollToTopAfterClick`
`protected long`	`mSelectedItemIdentifier`
`protected int`	`mSelectedItemPosition`
`protected boolean`	`mShowDrawerOnFirstLaunch`
`protected int`	`mSliderBackgroundColor`
`protected int`	`mSliderBackgroundColorRes`
`protected android.graphics.drawable.Drawable`	`mSliderBackgroundDrawable`
`protected int`	`mSliderBackgroundDrawableRes`
`protected com.mikepenz.materialize.view.ScrimInsetsRelativeLayout`	`mSliderLayout`
`protected java.util.List<IDrawerItem>`	`mStickyDrawerItems`
`protected boolean`	`mStickyFooterDivider`
`protected boolean`	`mStickyFooterShadow`
`protected android.view.View`	`mStickyFooterShadowView`
`protected android.view.ViewGroup`	`mStickyFooterView`
`protected boolean`	`mStickyHeaderShadow`
`protected android.view.View`	`mStickyHeaderView`
`protected boolean`	`mSystemUIHidden`
`protected android.support.v7.widget.Toolbar`	`mToolbar`
`protected boolean`	`mTranslucentNavigationBar`
`protected boolean`	`mTranslucentNavigationBarProgrammatically`
`protected boolean`	`mTranslucentStatusBar`
`protected boolean`	`mUsed`

Constructor Summary

Constructors
Constructor and Description
`DrawerBuilder()` default constructor
`DrawerBuilder(android.app.Activity activity)` Construct a Drawer by passing the activity to use for the generation

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DrawerBuilder`	`addDrawerItems(IDrawerItem... drawerItems)` Add a initial DrawerItem or a DrawerItem Array for the Drawer
`DrawerBuilder`	`addStickyDrawerItems(IDrawerItem... stickyDrawerItems)` Add a initial DrawerItem or a DrawerItem Array for the StickyDrawerFooter
`Drawer`	`append(Drawer result)` Call this method to append a new DrawerBuilder to a existing Drawer.
`Drawer`	`build()` Build and add the DrawerBuilder to your activity
`Drawer`	`buildForFragment()` Build and add the DrawerBuilder to your activity
`Drawer`	`buildView()` build the drawers content only.
`protected boolean`	`checkDrawerItem(int position, boolean includeOffset)` check if the item is within the bounds of the list
`protected void`	`closeDrawerDelayed()` helper method to close the drawer delayed
`protected com.mikepenz.fastadapter.FastAdapter<IDrawerItem>`	`getAdapter()` get the adapter (null safe)
`protected IDrawerItem`	`getDrawerItem(int position)` get the drawerItem at a specific position
`protected com.mikepenz.fastadapter.IItemAdapter<IDrawerItem>`	`getFooterAdapter()`
`protected com.mikepenz.fastadapter.IItemAdapter<IDrawerItem>`	`getHeaderAdapter()`
`protected com.mikepenz.fastadapter.IItemAdapter<IDrawerItem>`	`getItemAdapter()`
`protected void`	`handleDrawerNavigation(android.app.Activity activity, boolean recreateActionBarDrawerToggle)` handles the different logics for the Drawer Navigation Listeners / Indications (ActionBarDrawertoggle)
`DrawerBuilder`	`inflateMenu(int menuRes)` Inflates the DrawerItems from a menu.xml
`protected void`	`resetStickyFooterSelection()` simple helper method to reset the selection of the sticky footer
`DrawerBuilder`	`withAccountHeader(AccountHeader accountHeader)` Add a AccountSwitcherHeader which will be used in this drawer instance.
`DrawerBuilder`	`withAccountHeader(AccountHeader accountHeader, boolean accountHeaderSticky)` Add a AccountSwitcherHeader which will be used in this drawer instance.
`DrawerBuilder`	`withActionBarDrawerToggle(android.support.v7.app.ActionBarDrawerToggle actionBarDrawerToggle)` Add a custom ActionBarDrawerToggle which will be used in combination with this drawer.
`DrawerBuilder`	`withActionBarDrawerToggle(boolean actionBarDrawerToggleEnabled)` Set this to false if you don't need the included ActionBarDrawerToggle
`DrawerBuilder`	`withActionBarDrawerToggleAnimated(boolean actionBarDrawerToggleAnimated)` Set this to true if you want the ActionBarDrawerToggle to be animated.
`DrawerBuilder`	`withActivity(android.app.Activity activity)` Sets the activity which will be generated for the generation The activity is required and will be used to inflate the content in.
`DrawerBuilder`	`withAdapter(com.mikepenz.fastadapter.FastAdapter<IDrawerItem> adapter)` Define a custom Adapter which will be used in the drawer NOTE: this is not recommender WARNING: if you do this after adding items you will loose those!
`DrawerBuilder`	`withAdapterWrapper(android.support.v7.widget.RecyclerView.Adapter adapterWrapper)` Defines a Adapter which wraps the main Adapter used in the RecyclerView to allow extended navigation and other stuff
`DrawerBuilder`	`withCloseOnClick(boolean closeOnClick)` Set this to false if the drawer should stay opened after an item was clicked
`DrawerBuilder`	`withCustomView(android.view.View customView)` Pass a custom view if you need a completely custom drawer content
`DrawerBuilder`	`withDelayDrawerClickEvent(int delayDrawerClickEvent)` Define the delay for the drawer click event after a click.
`DrawerBuilder`	`withDelayOnDrawerClose(int delayOnDrawerClose)` Define the delay for the drawer close operation after a click.
`DrawerBuilder`	`withDisplayBelowStatusBar(boolean displayBelowStatusBar)` Sets that the slider of this Drawer should be displayed below the statusBar even with a translucentStatusBar
`DrawerBuilder`	`withDrawerGravity(int gravity)` Set the gravity for the drawer.
`DrawerBuilder`	`withDrawerItems(java.util.List<IDrawerItem> drawerItems)` Set the initial List of IDrawerItems for the Drawer
`DrawerBuilder`	`withDrawerLayout(android.support.v4.widget.DrawerLayout drawerLayout)` Pass a custom DrawerLayout which will be used.
`DrawerBuilder`	`withDrawerLayout(int resLayout)` Pass a custom DrawerLayout Resource which will be used.
`DrawerBuilder`	`withDrawerWidthDp(int drawerWidthDp)` Set the DrawerBuilder width with a dp value
`DrawerBuilder`	`withDrawerWidthPx(int drawerWidthPx)` Set the DrawerBuilder width with a pixel value
`DrawerBuilder`	`withDrawerWidthRes(int drawerWidthRes)` Set the DrawerBuilder width with a dimension resource
`DrawerBuilder`	`withFireOnInitialOnClick(boolean fireOnInitialOnClick)` Set this to true if you love to get an initial onClick event after the build method is called
`DrawerBuilder`	`withFooter(int footerViewRes)` Add a footer to the DrawerBuilder ListView defined by a resource.
`DrawerBuilder`	`withFooter(android.view.View footerView)` Add a footer to the DrawerBuilder ListView.
`DrawerBuilder`	`withFooterClickable(boolean footerClickable)` Set this to true if you want the footer to be clickable
`DrawerBuilder`	`withFooterDivider(boolean footerDivider)` Set this to false if you don't need the divider above the footer
`DrawerBuilder`	`withFullscreen(boolean fullscreen)` Set to true if the used theme has a translucent statusBar and navigationBar and you want to manage the padding on your own.
`DrawerBuilder`	`withGenerateMiniDrawer(boolean generateMiniDrawer)` define if the DrawerBuilder should also generate a MiniDrawer for th
`DrawerBuilder`	`withHasStableIds(boolean hasStableIds)` define this if you want enable hasStableIds for the adapter which is generated.
`DrawerBuilder`	`withHeader(int headerViewRes)` Add a header to the DrawerBuilder ListView defined by a resource.
`DrawerBuilder`	`withHeader(android.view.View headerView)` Add a header to the DrawerBuilder ListView.
`DrawerBuilder`	`withHeaderDivider(boolean headerDivider)` Set this to false if you don't need the divider below the header
`DrawerBuilder`	`withHeaderHeight(DimenHolder headerHeight)` Sets the header height for the header provided via `withHeader()`
`DrawerBuilder`	`withHeaderPadding(boolean headerPadding)` Set this to false if you don't need the padding below the header
`DrawerBuilder`	`withInnerShadow(boolean innerShadow)` sets if the drawer should show an inner shadow or not
`DrawerBuilder`	`withItemAnimator(android.support.v7.widget.RecyclerView.ItemAnimator itemAnimator)` defines the itemAnimator to be used in conjunction with the RecyclerView
`DrawerBuilder`	`withMultiSelect(boolean multiSelect)` set this to true if you want to enable multiSelect mode inside the drawer.
`DrawerBuilder`	`withOnDrawerItemClickListener(Drawer.OnDrawerItemClickListener onDrawerItemClickListener)` Define a OnDrawerItemClickListener for this Drawer
`DrawerBuilder`	`withOnDrawerItemLongClickListener(Drawer.OnDrawerItemLongClickListener onDrawerItemLongClickListener)` Define a OnDrawerItemLongClickListener for this Drawer
`DrawerBuilder`	`withOnDrawerListener(Drawer.OnDrawerListener onDrawerListener)` Define a OnDrawerListener for this Drawer
`DrawerBuilder`	`withOnDrawerNavigationListener(Drawer.OnDrawerNavigationListener onDrawerNavigationListener)` Define a OnDrawerNavigationListener for this Drawer
`DrawerBuilder`	`withPositionBasedStateManagement(boolean positionBasedStateManagement)` This allows to disable the default position based statemanagment of the FastAdapter and switch to the new identifier based state managment
`DrawerBuilder`	`withRecyclerView(android.support.v7.widget.RecyclerView recyclerView)` Define a custom RecyclerView which will be used in the drawer NOTE: this is not recommended
`DrawerBuilder`	`withRootView(int rootViewRes)` Sets the rootView which will host the DrawerLayout The content of this view will be extracted and added as the new content inside the drawerLayout
`DrawerBuilder`	`withRootView(android.view.ViewGroup rootView)` Sets the rootView which will host the DrawerLayout The content of this view will be extracted and added as the new content inside the drawerLayout
`DrawerBuilder`	`withSavedInstance(android.os.Bundle savedInstance)` Set the Bundle (savedInstance) which is passed by the activity.
`DrawerBuilder`	`withScrollToTopAfterClick(boolean scrollToTopAfterClick)` defines if the drawer should scroll to top after click
`DrawerBuilder`	`withSelectedItem(long selectedItemIdentifier)` Set this to the identifier of the item, you would love to select upon start
`DrawerBuilder`	`withSelectedItemByPosition(int selectedItemPosition)` Set this to the index of the item, you would love to select upon start
`DrawerBuilder`	`withShowDrawerOnFirstLaunch(boolean showDrawerOnFirstLaunch)` define if the DrawerBuilder is shown on the first launch
`DrawerBuilder`	`withSliderBackgroundColor(int sliderBackgroundColor)` Set the background color for the Slider.
`DrawerBuilder`	`withSliderBackgroundColorRes(int sliderBackgroundColorRes)` Set the background color for the Slider from a Resource.
`DrawerBuilder`	`withSliderBackgroundDrawable(android.graphics.drawable.Drawable sliderBackgroundDrawable)` Set the background drawable for the Slider.
`DrawerBuilder`	`withSliderBackgroundDrawableRes(int sliderBackgroundDrawableRes)` Set the background drawable for the Slider from a Resource.
`DrawerBuilder`	`withStickyDrawerItems(java.util.List<IDrawerItem> stickyDrawerItems)` Set the initial List of IDrawerItems for the StickyDrawerFooter
`DrawerBuilder`	`withStickyFooter(int stickyFooterRes)` Add a sticky footer below the DrawerBuilder ListView defined by a resource.
`DrawerBuilder`	`withStickyFooter(android.view.ViewGroup stickyFooter)` Add a sticky footer below the DrawerBuilder ListView.
`DrawerBuilder`	`withStickyFooterDivider(boolean stickyFooterDivider)` Set this to true if you want the divider above the sticky footer
`DrawerBuilder`	`withStickyFooterShadow(boolean stickyFooterShadow)` Set this to false if you don't want the shadow on top of the sticky footer
`DrawerBuilder`	`withStickyHeader(int stickyHeaderRes)` Add a sticky header below the DrawerBuilder ListView defined by a resource.
`DrawerBuilder`	`withStickyHeader(android.view.View stickyHeader)` Add a sticky header below the DrawerBuilder ListView.
`DrawerBuilder`	`withStickyHeaderShadow(boolean stickyHeaderShadow)` Set this to false if you don't want the shadow below the sticky header
`DrawerBuilder`	`withSystemUIHidden(boolean systemUIHidden)` Set to true if you use your app in complete fullscreen mode with hidden statusBar and navigationBar
`DrawerBuilder`	`withToolbar(android.support.v7.widget.Toolbar toolbar)` Sets the toolbar which should be used in combination with the drawer This will handle the ActionBarDrawerToggle for you.
`DrawerBuilder`	`withTranslucentNavigationBar(boolean translucentNavigationBar)` Set to true if you use a translucent NavigationBar
`DrawerBuilder`	`withTranslucentNavigationBarProgrammatically(boolean translucentNavigationBarProgrammatically)` set this to true if you want a translucent navigation bar.
`DrawerBuilder`	`withTranslucentStatusBar(boolean translucentStatusBar)` Sets that the view which hosts the DrawerLayout should have a translucent statusBar This is true by default, so it's possible to display the drawer under the statusBar

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - mUsed
```
protected boolean mUsed
```
  - mCurrentStickyFooterSelection
```
protected int mCurrentStickyFooterSelection
```
  - mAppended
```
protected boolean mAppended
```
  - mActivity
```
protected android.app.Activity mActivity
```
  - mLayoutManager
```
protected android.support.v7.widget.RecyclerView.LayoutManager mLayoutManager
```
  - mRootView
```
protected android.view.ViewGroup mRootView
```
  - mMaterialize
```
protected com.mikepenz.materialize.Materialize mMaterialize
```
  - mTranslucentStatusBar
```
protected boolean mTranslucentStatusBar
```
  - mDisplayBelowStatusBar
```
protected java.lang.Boolean mDisplayBelowStatusBar
```
  - mToolbar
```
protected android.support.v7.widget.Toolbar mToolbar
```
  - mTranslucentNavigationBar
```
protected boolean mTranslucentNavigationBar
```
  - mTranslucentNavigationBarProgrammatically
```
protected boolean mTranslucentNavigationBarProgrammatically
```
  - mFullscreen
```
protected boolean mFullscreen
```
  - mSystemUIHidden
```
protected boolean mSystemUIHidden
```
  - mCustomView
```
protected android.view.View mCustomView
```
  - mDrawerLayout
```
protected android.support.v4.widget.DrawerLayout mDrawerLayout
```
  - mSliderLayout
```
protected com.mikepenz.materialize.view.ScrimInsetsRelativeLayout mSliderLayout
```
  - mSliderBackgroundColor
```
protected int mSliderBackgroundColor
```
  - mSliderBackgroundColorRes
```
protected int mSliderBackgroundColorRes
```
  - mSliderBackgroundDrawable
```
protected android.graphics.drawable.Drawable mSliderBackgroundDrawable
```
  - mSliderBackgroundDrawableRes
```
protected int mSliderBackgroundDrawableRes
```
  - mDrawerWidth
```
protected int mDrawerWidth
```
  - mDrawerGravity
```
protected java.lang.Integer mDrawerGravity
```
  - mAccountHeader
```
protected AccountHeader mAccountHeader
```
  - mAccountHeaderSticky
```
protected boolean mAccountHeaderSticky
```
  - mAnimateActionBarDrawerToggle
```
protected boolean mAnimateActionBarDrawerToggle
```
  - mActionBarDrawerToggleEnabled
```
protected boolean mActionBarDrawerToggleEnabled
```
  - mActionBarDrawerToggle
```
protected android.support.v7.app.ActionBarDrawerToggle mActionBarDrawerToggle
```
  - mScrollToTopAfterClick
```
protected boolean mScrollToTopAfterClick
```
  - mHeaderView
```
protected android.view.View mHeaderView
```
  - mHeaderDivider
```
protected boolean mHeaderDivider
```
  - mHeaderPadding
```
protected boolean mHeaderPadding
```
  - mHeiderHeight
```
protected DimenHolder mHeiderHeight
```
  - mStickyHeaderView
```
protected android.view.View mStickyHeaderView
```
  - mStickyHeaderShadow
```
protected boolean mStickyHeaderShadow
```
  - mFooterView
```
protected android.view.View mFooterView
```
  - mFooterDivider
```
protected boolean mFooterDivider
```
  - mFooterClickable
```
protected boolean mFooterClickable
```
  - mStickyFooterView
```
protected android.view.ViewGroup mStickyFooterView
```
  - mStickyFooterDivider
```
protected boolean mStickyFooterDivider
```
  - mStickyFooterShadowView
```
protected android.view.View mStickyFooterShadowView
```
  - mStickyFooterShadow
```
protected boolean mStickyFooterShadow
```
  - mFireInitialOnClick
```
protected boolean mFireInitialOnClick
```
  - mMultiSelect
```
protected boolean mMultiSelect
```
  - mSelectedItemPosition
```
protected int mSelectedItemPosition
```
  - mSelectedItemIdentifier
```
protected long mSelectedItemIdentifier
```
  - mRecyclerView
```
protected android.support.v7.widget.RecyclerView mRecyclerView
```
  - mHasStableIds
```
protected boolean mHasStableIds
```
  - mPositionBasedStateManagement
```
protected boolean mPositionBasedStateManagement
```
  - mAdapter
```
protected com.mikepenz.fastadapter.FastAdapter<IDrawerItem> mAdapter
```
  - mHeaderAdapter
```
protected com.mikepenz.fastadapter.adapters.HeaderAdapter<IDrawerItem> mHeaderAdapter
```
  - mItemAdapter
```
protected com.mikepenz.fastadapter.adapters.ItemAdapter<IDrawerItem> mItemAdapter
```
  - mFooterAdapter
```
protected com.mikepenz.fastadapter.adapters.FooterAdapter<IDrawerItem> mFooterAdapter
```
  - mAdapterWrapper
```
protected android.support.v7.widget.RecyclerView.Adapter mAdapterWrapper
```
  - mItemAnimator
```
protected android.support.v7.widget.RecyclerView.ItemAnimator mItemAnimator
```
  - mStickyDrawerItems
```
protected java.util.List<IDrawerItem> mStickyDrawerItems
```
  - mCloseOnClick
```
protected boolean mCloseOnClick
```
  - mDelayOnDrawerClose
```
protected int mDelayOnDrawerClose
```
  - mDelayDrawerClickEvent
```
protected int mDelayDrawerClickEvent
```
  - mOnDrawerListener
```
protected Drawer.OnDrawerListener mOnDrawerListener
```
  - mOnDrawerItemClickListener
```
protected Drawer.OnDrawerItemClickListener mOnDrawerItemClickListener
```
  - mOnDrawerItemLongClickListener
```
protected Drawer.OnDrawerItemLongClickListener mOnDrawerItemLongClickListener
```
  - mOnDrawerNavigationListener
```
protected Drawer.OnDrawerNavigationListener mOnDrawerNavigationListener
```
  - mShowDrawerOnFirstLaunch
```
protected boolean mShowDrawerOnFirstLaunch
```
  - mGenerateMiniDrawer
```
protected boolean mGenerateMiniDrawer
```
  - mMiniDrawer
```
protected MiniDrawer mMiniDrawer
```
  - mSavedInstance
```
protected android.os.Bundle mSavedInstance
```
- Constructor Detail
  - DrawerBuilder
```
public DrawerBuilder()
```
    default constructor
  - DrawerBuilder
```
public DrawerBuilder(@NonNull
                     android.app.Activity activity)
```
    Construct a Drawer by passing the activity to use for the generation
    
    Parameters:
    
    activity - current activity which will contain the drawer
- Method Detail
  - withActivity
```
public DrawerBuilder withActivity(@NonNull
                                  android.app.Activity activity)
```
    Sets the activity which will be generated for the generation The activity is required and will be used to inflate the content in. After generation it is set to null to prevent a memory leak.
    
    Parameters:
    
    activity - current activity which will contain the drawer
  - withRootView
```
public DrawerBuilder withRootView(@NonNull
                                  android.view.ViewGroup rootView)
```
    Sets the rootView which will host the DrawerLayout The content of this view will be extracted and added as the new content inside the drawerLayout
    
    Parameters:
    
    rootView - a view which will get switched out by the DrawerLayout and added as its child
  - withRootView
```
public DrawerBuilder withRootView(@IdRes
                                  int rootViewRes)
```
    Sets the rootView which will host the DrawerLayout The content of this view will be extracted and added as the new content inside the drawerLayout
    
    Parameters:
    
    rootViewRes - the id of a view which will get switched out by the DrawerLayout and added as its child
  - withTranslucentStatusBar
```
public DrawerBuilder withTranslucentStatusBar(boolean translucentStatusBar)
```
    Sets that the view which hosts the DrawerLayout should have a translucent statusBar This is true by default, so it's possible to display the drawer under the statusBar
    
    Parameters:
    
    translucentStatusBar - sets whether the statusBar is transparent (and the drawer is displayed under it) or not
  - withDisplayBelowStatusBar
```
public DrawerBuilder withDisplayBelowStatusBar(boolean displayBelowStatusBar)
```
    Sets that the slider of this Drawer should be displayed below the statusBar even with a translucentStatusBar
    
    Parameters:
    
    displayBelowStatusBar - sets wheter the slider of the drawer is displayed below the statusBar or not
  - withInnerShadow
```
public DrawerBuilder withInnerShadow(boolean innerShadow)
```
    sets if the drawer should show an inner shadow or not
    
    Parameters:
    
    innerShadow - sets wheter the drawer should display an inner shadow or not
    
    Returns:
  - withToolbar
```
public DrawerBuilder withToolbar(@NonNull
                                 android.support.v7.widget.Toolbar toolbar)
```
    Sets the toolbar which should be used in combination with the drawer This will handle the ActionBarDrawerToggle for you. Do not set this if you are in a sub activity and want to handle the back arrow on your own
    
    Parameters:
    
    toolbar - the toolbar which is used in combination with the drawer
  - withTranslucentNavigationBar
```
public DrawerBuilder withTranslucentNavigationBar(boolean translucentNavigationBar)
```
    Set to true if you use a translucent NavigationBar
    
    Parameters:
    
    translucentNavigationBar -
    
    Returns:
  - withTranslucentNavigationBarProgrammatically
```
public DrawerBuilder withTranslucentNavigationBarProgrammatically(boolean translucentNavigationBarProgrammatically)
```
    set this to true if you want a translucent navigation bar.
    
    Parameters:
    
    translucentNavigationBarProgrammatically -
    
    Returns:
  - withFullscreen
```
public DrawerBuilder withFullscreen(boolean fullscreen)
```
    Set to true if the used theme has a translucent statusBar and navigationBar and you want to manage the padding on your own.
    
    Parameters:
    
    fullscreen -
    
    Returns:
  - withSystemUIHidden
```
public DrawerBuilder withSystemUIHidden(boolean systemUIHidden)
```
    Set to true if you use your app in complete fullscreen mode with hidden statusBar and navigationBar
    
    Parameters:
    
    systemUIHidden -
    
    Returns:
  - withCustomView
```
public DrawerBuilder withCustomView(@NonNull
                                    android.view.View customView)
```
    Pass a custom view if you need a completely custom drawer content
    
    Parameters:
    
    customView -
    
    Returns:
  - withDrawerLayout
```
public DrawerBuilder withDrawerLayout(@NonNull
                                      android.support.v4.widget.DrawerLayout drawerLayout)
```
    Pass a custom DrawerLayout which will be used. NOTE: This requires the same structure as the drawer.xml
    
    Parameters:
    
    drawerLayout -
    
    Returns:
  - withDrawerLayout
```
public DrawerBuilder withDrawerLayout(@LayoutRes
                                      int resLayout)
```
    Pass a custom DrawerLayout Resource which will be used. NOTE: This requires the same structure as the drawer.xml
    
    Parameters:
    
    resLayout -
    
    Returns:
  - withSliderBackgroundColor
```
public DrawerBuilder withSliderBackgroundColor(int sliderBackgroundColor)
```
    Set the background color for the Slider. This is the view containing the list.
    
    Parameters:
    
    sliderBackgroundColor -
    
    Returns:
  - withSliderBackgroundColorRes
```
public DrawerBuilder withSliderBackgroundColorRes(@ColorRes
                                                  int sliderBackgroundColorRes)
```
    Set the background color for the Slider from a Resource. This is the view containing the list.
    
    Parameters:
    
    sliderBackgroundColorRes -
    
    Returns:
  - withSliderBackgroundDrawable
```
public DrawerBuilder withSliderBackgroundDrawable(@NonNull
                                                  android.graphics.drawable.Drawable sliderBackgroundDrawable)
```
    Set the background drawable for the Slider. This is the view containing the list.
    
    Parameters:
    
    sliderBackgroundDrawable -
    
    Returns:
  - withSliderBackgroundDrawableRes
```
public DrawerBuilder withSliderBackgroundDrawableRes(@DrawableRes
                                                     int sliderBackgroundDrawableRes)
```
    Set the background drawable for the Slider from a Resource. This is the view containing the list.
    
    Parameters:
    
    sliderBackgroundDrawableRes -
    
    Returns:
  - withDrawerWidthPx
```
public DrawerBuilder withDrawerWidthPx(int drawerWidthPx)
```
    Set the DrawerBuilder width with a pixel value
    
    Parameters:
    
    drawerWidthPx -
    
    Returns:
  - withDrawerWidthDp
```
public DrawerBuilder withDrawerWidthDp(int drawerWidthDp)
```
    Set the DrawerBuilder width with a dp value
    
    Parameters:
    
    drawerWidthDp -
    
    Returns:
  - withDrawerWidthRes
```
public DrawerBuilder withDrawerWidthRes(@DimenRes
                                        int drawerWidthRes)
```
    Set the DrawerBuilder width with a dimension resource
    
    Parameters:
    
    drawerWidthRes -
    
    Returns:
  - withDrawerGravity
```
public DrawerBuilder withDrawerGravity(int gravity)
```
    Set the gravity for the drawer. START, LEFT | RIGHT, END
    
    Parameters:
    
    gravity -
    
    Returns:
  - withAccountHeader
```
public DrawerBuilder withAccountHeader(@NonNull
                                       AccountHeader accountHeader)
```
    Add a AccountSwitcherHeader which will be used in this drawer instance. NOTE: This will overwrite any set headerView.
    
    Parameters:
    
    accountHeader -
    
    Returns:
  - withAccountHeader
```
public DrawerBuilder withAccountHeader(@NonNull
                                       AccountHeader accountHeader,
                                       boolean accountHeaderSticky)
```
    Add a AccountSwitcherHeader which will be used in this drawer instance. Pass true if it should be sticky NOTE: This will overwrite any set headerView or stickyHeaderView (depends on the boolean).
    
    Parameters:
    
    accountHeader -
    
    accountHeaderSticky -
    
    Returns:
  - withActionBarDrawerToggleAnimated
```
public DrawerBuilder withActionBarDrawerToggleAnimated(boolean actionBarDrawerToggleAnimated)
```
    Set this to true if you want the ActionBarDrawerToggle to be animated. NOTE: This will only work if the built in ActionBarDrawerToggle is used. Enable it by setting withActionBarDrawerToggle to true
    
    Parameters:
    
    actionBarDrawerToggleAnimated -
    
    Returns:
  - withActionBarDrawerToggle
```
public DrawerBuilder withActionBarDrawerToggle(boolean actionBarDrawerToggleEnabled)
```
    Set this to false if you don't need the included ActionBarDrawerToggle
    
    Parameters:
    
    actionBarDrawerToggleEnabled -
    
    Returns:
  - withActionBarDrawerToggle
```
public DrawerBuilder withActionBarDrawerToggle(@NonNull
                                               android.support.v7.app.ActionBarDrawerToggle actionBarDrawerToggle)
```
    Add a custom ActionBarDrawerToggle which will be used in combination with this drawer.
    
    Parameters:
    
    actionBarDrawerToggle -
    
    Returns:
  - withScrollToTopAfterClick
```
public DrawerBuilder withScrollToTopAfterClick(boolean scrollToTopAfterClick)
```
    defines if the drawer should scroll to top after click
    
    Parameters:
    
    scrollToTopAfterClick -
    
    Returns:
  - withHeader
```
public DrawerBuilder withHeader(@NonNull
                                android.view.View headerView)
```
    Add a header to the DrawerBuilder ListView. This can be any view
    
    Parameters:
    
    headerView -
    
    Returns:
  - withHeader
```
public DrawerBuilder withHeader(@LayoutRes
                                int headerViewRes)
```
    Add a header to the DrawerBuilder ListView defined by a resource.
    
    Parameters:
    
    headerViewRes -
    
    Returns:
  - withHeaderDivider
```
public DrawerBuilder withHeaderDivider(boolean headerDivider)
```
    Set this to false if you don't need the divider below the header
    
    Parameters:
    
    headerDivider -
    
    Returns:
  - withHeaderPadding
```
public DrawerBuilder withHeaderPadding(boolean headerPadding)
```
    Set this to false if you don't need the padding below the header
    
    Parameters:
    
    headerPadding -
    
    Returns:
  - withHeaderHeight
```
public DrawerBuilder withHeaderHeight(DimenHolder headerHeight)
```
    Sets the header height for the header provided via `withHeader()`
    
    Parameters:
    
    headerHeight - the DimenHolder with the height we want to set for the header
    
    Returns:
  - withStickyHeader
```
public DrawerBuilder withStickyHeader(@NonNull
                                      android.view.View stickyHeader)
```
    Add a sticky header below the DrawerBuilder ListView. This can be any view
    
    Parameters:
    
    stickyHeader -
    
    Returns:
  - withStickyHeader
```
public DrawerBuilder withStickyHeader(@LayoutRes
                                      int stickyHeaderRes)
```
    Add a sticky header below the DrawerBuilder ListView defined by a resource.
    
    Parameters:
    
    stickyHeaderRes -
    
    Returns:
  - withStickyHeaderShadow
```
public DrawerBuilder withStickyHeaderShadow(boolean stickyHeaderShadow)
```
    Set this to false if you don't want the shadow below the sticky header
    
    Parameters:
    
    stickyHeaderShadow -
    
    Returns:
  - withFooter
```
public DrawerBuilder withFooter(@NonNull
                                android.view.View footerView)
```
    Add a footer to the DrawerBuilder ListView. This can be any view
    
    Parameters:
    
    footerView -
    
    Returns:
  - withFooter
```
public DrawerBuilder withFooter(@LayoutRes
                                int footerViewRes)
```
    Add a footer to the DrawerBuilder ListView defined by a resource.
    
    Parameters:
    
    footerViewRes -
    
    Returns:
  - withFooterClickable
```
public DrawerBuilder withFooterClickable(boolean footerClickable)
```
    Set this to true if you want the footer to be clickable
    
    Parameters:
    
    footerClickable -
    
    Returns:
  - withFooterDivider
```
public DrawerBuilder withFooterDivider(boolean footerDivider)
```
    Set this to false if you don't need the divider above the footer
    
    Parameters:
    
    footerDivider -
    
    Returns:
  - withStickyFooter
```
public DrawerBuilder withStickyFooter(@NonNull
                                      android.view.ViewGroup stickyFooter)
```
    Add a sticky footer below the DrawerBuilder ListView. This can be any view
    
    Parameters:
    
    stickyFooter -
    
    Returns:
  - withStickyFooter
```
public DrawerBuilder withStickyFooter(@LayoutRes
                                      int stickyFooterRes)
```
    Add a sticky footer below the DrawerBuilder ListView defined by a resource.
    
    Parameters:
    
    stickyFooterRes -
    
    Returns:
  - withStickyFooterDivider
```
public DrawerBuilder withStickyFooterDivider(boolean stickyFooterDivider)
```
    Set this to true if you want the divider above the sticky footer
    
    Parameters:
    
    stickyFooterDivider -
    
    Returns:
  - withStickyFooterShadow
```
public DrawerBuilder withStickyFooterShadow(boolean stickyFooterShadow)
```
    Set this to false if you don't want the shadow on top of the sticky footer
    
    Parameters:
    
    stickyFooterShadow -
    
    Returns:
  - withFireOnInitialOnClick
```
public DrawerBuilder withFireOnInitialOnClick(boolean fireOnInitialOnClick)
```
    Set this to true if you love to get an initial onClick event after the build method is called
    
    Parameters:
    
    fireOnInitialOnClick -
    
    Returns:
  - withMultiSelect
```
public DrawerBuilder withMultiSelect(boolean multiSelect)
```
    set this to true if you want to enable multiSelect mode inside the drawer. Note you will have to programmatically deselect if you want to remove all selections! You can disable this at a later time via .getAdapter().withMultiSelect(false) You can also modify all other settings of the FastAdapter via this method
    
    Parameters:
    
    multiSelect - true if multiSelect is enabled (default: false)
    
    Returns:
    
    this
  - withSelectedItemByPosition
```
public DrawerBuilder withSelectedItemByPosition(int selectedItemPosition)
```
    Set this to the index of the item, you would love to select upon start
    
    Parameters:
    
    selectedItemPosition -
    
    Returns:
  - withSelectedItem
```
public DrawerBuilder withSelectedItem(long selectedItemIdentifier)
```
    Set this to the identifier of the item, you would love to select upon start
    
    Parameters:
    
    selectedItemIdentifier -
    
    Returns:
  - withRecyclerView
```
public DrawerBuilder withRecyclerView(@NonNull
                                      android.support.v7.widget.RecyclerView recyclerView)
```
    Define a custom RecyclerView which will be used in the drawer NOTE: this is not recommended
    
    Parameters:
    
    recyclerView -
    
    Returns:
  - withHasStableIds
```
public DrawerBuilder withHasStableIds(boolean hasStableIds)
```
    define this if you want enable hasStableIds for the adapter which is generated. WARNING: only use this if you have set an identifer for all of your items else this could cause many weird things
    
    Parameters:
    
    hasStableIds -
    
    Returns:
  - withPositionBasedStateManagement
```
public DrawerBuilder withPositionBasedStateManagement(boolean positionBasedStateManagement)
```
    This allows to disable the default position based statemanagment of the FastAdapter and switch to the new identifier based state managment
    
    Parameters:
    
    positionBasedStateManagement - enable / disable the positionBasedStateManagement
    
    Returns:
    
    this
  - withAdapter
```
public DrawerBuilder withAdapter(@NonNull
                                 com.mikepenz.fastadapter.FastAdapter<IDrawerItem> adapter)
```
    Define a custom Adapter which will be used in the drawer NOTE: this is not recommender WARNING: if you do this after adding items you will loose those!
    
    Parameters:
    
    adapter - the FastAdapter to use with this drawer
    
    Returns:
    
    this
  - getAdapter
```
protected com.mikepenz.fastadapter.FastAdapter<IDrawerItem> getAdapter()
```
    get the adapter (null safe)
    
    Returns:
    
    the FastAdapter used with this drawer
  - getItemAdapter
```
protected com.mikepenz.fastadapter.IItemAdapter<IDrawerItem> getItemAdapter()
```
  - getHeaderAdapter
```
protected com.mikepenz.fastadapter.IItemAdapter<IDrawerItem> getHeaderAdapter()
```
  - getFooterAdapter
```
protected com.mikepenz.fastadapter.IItemAdapter<IDrawerItem> getFooterAdapter()
```
  - withAdapterWrapper
```
public DrawerBuilder withAdapterWrapper(@NonNull
                                        android.support.v7.widget.RecyclerView.Adapter adapterWrapper)
```
    Defines a Adapter which wraps the main Adapter used in the RecyclerView to allow extended navigation and other stuff
    
    Parameters:
    
    adapterWrapper -
    
    Returns:
  - withItemAnimator
```
public DrawerBuilder withItemAnimator(android.support.v7.widget.RecyclerView.ItemAnimator itemAnimator)
```
    defines the itemAnimator to be used in conjunction with the RecyclerView
    
    Parameters:
    
    itemAnimator -
    
    Returns:
  - withDrawerItems
```
public DrawerBuilder withDrawerItems(@NonNull
                                     java.util.List<IDrawerItem> drawerItems)
```
    Set the initial List of IDrawerItems for the Drawer
    
    Parameters:
    
    drawerItems -
    
    Returns:
  - addDrawerItems
```
public DrawerBuilder addDrawerItems(@NonNull
                                    IDrawerItem... drawerItems)
```
    Add a initial DrawerItem or a DrawerItem Array for the Drawer
    
    Parameters:
    
    drawerItems -
    
    Returns:
  - withStickyDrawerItems
```
public DrawerBuilder withStickyDrawerItems(@NonNull
                                           java.util.List<IDrawerItem> stickyDrawerItems)
```
    Set the initial List of IDrawerItems for the StickyDrawerFooter
    
    Parameters:
    
    stickyDrawerItems -
    
    Returns:
  - addStickyDrawerItems
```
public DrawerBuilder addStickyDrawerItems(@NonNull
                                          IDrawerItem... stickyDrawerItems)
```
    Add a initial DrawerItem or a DrawerItem Array for the StickyDrawerFooter
    
    Parameters:
    
    stickyDrawerItems -
    
    Returns:
  - inflateMenu
```
public DrawerBuilder inflateMenu(@MenuRes
                                 int menuRes)
```
    Inflates the DrawerItems from a menu.xml
    
    Parameters:
    
    menuRes -
    
    Returns:
  - withCloseOnClick
```
public DrawerBuilder withCloseOnClick(boolean closeOnClick)
```
    Set this to false if the drawer should stay opened after an item was clicked
    
    Parameters:
    
    closeOnClick -
    
    Returns:
    
    this
  - withDelayOnDrawerClose
```
public DrawerBuilder withDelayOnDrawerClose(int delayOnDrawerClose)
```
    Define the delay for the drawer close operation after a click. This is a small trick to improve the speed (and remove lag) if you open a new activity after a DrawerItem was selected. NOTE: Disable this by passing -1
    
    Parameters:
    
    delayOnDrawerClose - the delay in MS (-1 to disable)
    
    Returns:
    
    this
  - withDelayDrawerClickEvent
```
public DrawerBuilder withDelayDrawerClickEvent(int delayDrawerClickEvent)
```
    Define the delay for the drawer click event after a click. This can be used to improve performance and prevent lag, especially when you switch fragments inside the listener. This will ignore the boolean value you can return in the listener, as the listener is called after the drawer was closed. NOTE: Disable this to pass -1
    
    Parameters:
    
    delayDrawerClickEvent - -1 to disable
    
    Returns:
    
    this
  - withOnDrawerListener
```
public DrawerBuilder withOnDrawerListener(@NonNull
                                          Drawer.OnDrawerListener onDrawerListener)
```
    Define a OnDrawerListener for this Drawer
    
    Parameters:
    
    onDrawerListener -
    
    Returns:
    
    this
  - withOnDrawerItemClickListener
```
public DrawerBuilder withOnDrawerItemClickListener(@NonNull
                                                   Drawer.OnDrawerItemClickListener onDrawerItemClickListener)
```
    Define a OnDrawerItemClickListener for this Drawer
    
    Parameters:
    
    onDrawerItemClickListener -
    
    Returns:
  - withOnDrawerItemLongClickListener
```
public DrawerBuilder withOnDrawerItemLongClickListener(@NonNull
                                                       Drawer.OnDrawerItemLongClickListener onDrawerItemLongClickListener)
```
    Define a OnDrawerItemLongClickListener for this Drawer
    
    Parameters:
    
    onDrawerItemLongClickListener -
    
    Returns:
  - withOnDrawerNavigationListener
```
public DrawerBuilder withOnDrawerNavigationListener(@NonNull
                                                    Drawer.OnDrawerNavigationListener onDrawerNavigationListener)
```
    Define a OnDrawerNavigationListener for this Drawer
    
    Parameters:
    
    onDrawerNavigationListener -
    
    Returns:
    
    this
  - withShowDrawerOnFirstLaunch
```
public DrawerBuilder withShowDrawerOnFirstLaunch(boolean showDrawerOnFirstLaunch)
```
    define if the DrawerBuilder is shown on the first launch
    
    Parameters:
    
    showDrawerOnFirstLaunch -
    
    Returns:
  - withGenerateMiniDrawer
```
public DrawerBuilder withGenerateMiniDrawer(boolean generateMiniDrawer)
```
    define if the DrawerBuilder should also generate a MiniDrawer for th
    
    Parameters:
    
    generateMiniDrawer -
    
    Returns:
  - withSavedInstance
```
public DrawerBuilder withSavedInstance(android.os.Bundle savedInstance)
```
    Set the Bundle (savedInstance) which is passed by the activity. No need to null-check everything is handled automatically
    
    Parameters:
    
    savedInstance -
    
    Returns:
  - build
```
public Drawer build()
```
    Build and add the DrawerBuilder to your activity
    
    Returns:
  - buildForFragment
```
public Drawer buildForFragment()
```
    Build and add the DrawerBuilder to your activity
    
    Returns:
  - handleDrawerNavigation
```
protected void handleDrawerNavigation(android.app.Activity activity,
                                      boolean recreateActionBarDrawerToggle)
```
    handles the different logics for the Drawer Navigation Listeners / Indications (ActionBarDrawertoggle)
  - buildView
```
public Drawer buildView()
```
    build the drawers content only. This will still return a Result object, but only with the content set. No inflating of a DrawerLayout.
    
    Returns:
    
    Result object with only the content set
  - append
```
public Drawer append(@NonNull
                     Drawer result)
```
    Call this method to append a new DrawerBuilder to a existing Drawer.
    
    Parameters:
    
    result - the Drawer.Result of an existing Drawer
    
    Returns:
  - closeDrawerDelayed
```
protected void closeDrawerDelayed()
```
    helper method to close the drawer delayed
  - getDrawerItem
```
protected IDrawerItem getDrawerItem(int position)
```
    get the drawerItem at a specific position
    
    Parameters:
    
    position -
    
    Returns:
  - checkDrawerItem
```
protected boolean checkDrawerItem(int position,
                                  boolean includeOffset)
```
    check if the item is within the bounds of the list
    
    Parameters:
    
    position -
    
    includeOffset -
    
    Returns:
  - resetStickyFooterSelection
```
protected void resetStickyFooterSelection()
```
    simple helper method to reset the selection of the sticky footer

Class DrawerBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mUsed

mCurrentStickyFooterSelection

mAppended

mActivity

mLayoutManager

mRootView

mMaterialize

mTranslucentStatusBar

mDisplayBelowStatusBar

mToolbar

mTranslucentNavigationBar

mTranslucentNavigationBarProgrammatically

mFullscreen

mSystemUIHidden

mCustomView

mDrawerLayout

mSliderLayout

mSliderBackgroundColor

mSliderBackgroundColorRes

mSliderBackgroundDrawable

mSliderBackgroundDrawableRes

mDrawerWidth

mDrawerGravity

mAccountHeader

mAccountHeaderSticky

mAnimateActionBarDrawerToggle

mActionBarDrawerToggleEnabled

mActionBarDrawerToggle

mScrollToTopAfterClick

mHeaderView

mHeaderDivider

mHeaderPadding

mHeiderHeight

mStickyHeaderView

mStickyHeaderShadow

mFooterView

mFooterDivider

mFooterClickable

mStickyFooterView

mStickyFooterDivider

mStickyFooterShadowView

mStickyFooterShadow

mFireInitialOnClick

mMultiSelect

mSelectedItemPosition

mSelectedItemIdentifier

mRecyclerView

mHasStableIds

mPositionBasedStateManagement

mAdapter

mHeaderAdapter

mItemAdapter

mFooterAdapter

mAdapterWrapper

mItemAnimator

mStickyDrawerItems

mCloseOnClick

mDelayOnDrawerClose

mDelayDrawerClickEvent

mOnDrawerListener

mOnDrawerItemClickListener

mOnDrawerItemLongClickListener

mOnDrawerNavigationListener

mShowDrawerOnFirstLaunch

mGenerateMiniDrawer

mMiniDrawer

mSavedInstance

Constructor Detail

DrawerBuilder

DrawerBuilder

Method Detail

withActivity

withRootView

withRootView