BottomSheet.Builder (library API)

java.lang.Object
- de.mrapp.android.bottomsheet.BottomSheet.Builder

Enclosing class:

BottomSheet
```
public static class BottomSheet.Builder
extends java.lang.Object
```
A builder, which allows to create and show bottom sheets, which are designed according to Android 5's Material Design guidelines even on pre-Lollipop devices. Such a bottom sheet appears at the bottom of the window and consists of a title and multiple items. It is possible to customize the appearance of the bottom sheet or to replace its title and items with custom views.

Constructor Summary

Constructors
Constructor and Description
`Builder(android.content.Context context)` Creates a new builder, which allows to create bottom sheets, which are designed according to Android 5's Material Design guidelines even on pre-Lollipop devices.
`Builder(android.content.Context context, int themeResourceId)` Creates a new builder, which allows to create bottom sheets, which are designed according to Android 5's Material Design guidelines even on pre-Lollipop devices.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BottomSheet.Builder`	`addDivider()` Adds a new divider to the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`addDivider(java.lang.CharSequence title)` Adds a new divider to the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`addDivider(int titleId)` Adds a new divider to the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`addItem(int id, java.lang.CharSequence title)` Adds a new item to the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`addItem(int id, java.lang.CharSequence title, android.graphics.drawable.Drawable icon)` Adds a new item to the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`addItem(int id, int titleId)` Adds a new item to the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`addItem(int id, int titleId, int iconId)` Adds a new item to the bottom sheet, which is created by the builder.
`BottomSheet`	`create()` Creates a bottom sheet with the arguments, which have been supplied to the builder.
`android.content.Context`	`getContext()` Returns the context, which is used by the builder.
`BottomSheet`	`maximize()` Creates a bottom sheet with the arguments, which have been supplied to the builder and immediately maximizes it.
`BottomSheet.Builder`	`setBackground(android.graphics.Bitmap background)` Sets the background of the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setBackground(int resourceId)` Sets the background of the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setBackgroundColor(int color)` Sets the background color of the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setCancelable(boolean cancelable)` Sets, whether the bottom sheet, which is created by the builder, should be cancelable, or not.
`BottomSheet.Builder`	`setCustomTitle(int resourceId)` Sets the custom view, which should be used to show the title of the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setCustomTitle(android.view.View view)` Sets the custom view, which should be used to show the title of the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setDimAmount(float dimAmount)` Sets the dim amount, which should be used to darken the area outside the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setDividerColor(int color)` Sets the color of the dividers of the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setDragSensitivity(float dragSensitivity)` Sets the sensitivity, which specifies the distance after which dragging has an effect on the bottom sheet, in relation to an internal value range.
`BottomSheet.Builder`	`setIcon(android.graphics.Bitmap icon)` Sets the icon of the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setIcon(int resourceId)` Sets the icon of the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setIconAttribute(int attributeId)` Set the icon of the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setIntent(android.app.Activity activity, android.content.Intent intent)` Adds the apps, which are able to handle a specific intent, as items to the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setItemColor(int color)` Sets the color of the items of the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setItemEnabled(int index, boolean enabled)` Sets, whether the item at a specific index should be enabled, or not.
`BottomSheet.Builder`	`setOnCancelListener(android.content.DialogInterface.OnCancelListener listener)` Sets the listener, which should be notified, when the bottom sheet, which is created by the builder, is canceled.
`BottomSheet.Builder`	`setOnDismissListener(android.content.DialogInterface.OnDismissListener listener)` Sets the listener, which should be notified, when the bottom sheet, which is created by the builder, is dismissed for any reason.
`BottomSheet.Builder`	`setOnItemClickListener(android.widget.AdapterView.OnItemClickListener listener)` Sets the listener, which should be notified, when an item of the bottom sheet has been clicked.
`BottomSheet.Builder`	`setOnItemLongClickListener(android.widget.AdapterView.OnItemLongClickListener listener)` Sets the listener, which should be notified, when an item of the bottom sheet has been long-clicked.
`BottomSheet.Builder`	`setOnKeyListener(android.content.DialogInterface.OnKeyListener listener)` Sets the listener, which should be notified, if a key is dispatched to the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setOnMaximizeListener(OnMaximizeListener listener)` Sets the listener, which should be notified, when the bottom sheet, which is created by the builder, has been maximized.
`BottomSheet.Builder`	`setStyle(BottomSheet.Style style)` Sets the style of the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setTitle(java.lang.CharSequence title)` Sets the title of the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setTitle(int resourceId)` Sets the title of the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setTitleColor(int color)` Sets the color of the title of the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setView(int resourceId)` Sets the custom view, which should be shown by the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setView(android.view.View view)` Sets the custom view, which should be shown by the bottom sheet, which is created by the builder.
`BottomSheet.Builder`	`setWidth(int width)` Sets the width of the bottom sheet, which is created by the builder.
`BottomSheet`	`show()` Creates a bottom sheet with the arguments, which have been supplied to the builder and immediately displays it.

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

- Constructor Detail
  - Builder
```
public Builder(android.content.Context context)
```
    Creates a new builder, which allows to create bottom sheets, which are designed according to Android 5's Material Design guidelines even on pre-Lollipop devices.
    
    Parameters:
    
    context - The context, which should be used by the builder, as an instance of the class Context. The context may not be null
  - Builder
```
public Builder(android.content.Context context,
               int themeResourceId)
```
    Creates a new builder, which allows to create bottom sheets, which are designed according to Android 5's Material Design guidelines even on pre-Lollipop devices.
    
    Parameters:
    
    context - The context, which should be used by the builder, as an instance of the class Context. The context may not be null
    
    themeResourceId - The resource id of the theme, which should be used by the bottom sheet, as an Integer value. The resource id must correspond to a valid theme
- Method Detail
  - getContext
```
public final android.content.Context getContext()
```
    Returns the context, which is used by the builder.
    
    Returns:
    
    The context, which is used by the builder, as an instance of the class Context
  - setCancelable
```
public final BottomSheet.Builder setCancelable(boolean cancelable)
```
    Sets, whether the bottom sheet, which is created by the builder, should be cancelable, or not.
    
    Parameters:
    
    cancelable - True, if the bottom sheet, which is created by the builder, should be cancelable, false otherwise
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setStyle
```
public final BottomSheet.Builder setStyle(BottomSheet.Style style)
```
    Sets the style of the bottom sheet, which is created by the builder.
    
    Parameters:
    
    style - The style, which should be set, as a value of the enum BottomSheet.Style. The style may either be LIST, LIST_COLUMNS or GRID
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setOnItemClickListener
```
public final BottomSheet.Builder setOnItemClickListener(android.widget.AdapterView.OnItemClickListener listener)
```
    Sets the listener, which should be notified, when an item of the bottom sheet has been clicked.
    
    Parameters:
    
    listener - The listener, which should be set, as an instance of the type AdapterView.OnItemClickListener or null, if no listener should be notified
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setOnItemLongClickListener
```
public final BottomSheet.Builder setOnItemLongClickListener(android.widget.AdapterView.OnItemLongClickListener listener)
```
    Sets the listener, which should be notified, when an item of the bottom sheet has been long-clicked.
    
    Parameters:
    
    listener - The listener, which should be set, as an instance of the type AdapterView.OnItemLongClickListener or null, if no listener should be notified
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setOnMaximizeListener
```
public final BottomSheet.Builder setOnMaximizeListener(OnMaximizeListener listener)
```
    Sets the listener, which should be notified, when the bottom sheet, which is created by the builder, has been maximized.
    
    Parameters:
    
    listener - The listener, which should be set, as an instance of the type OnMaximizeListener or null, if no listener should be notified
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setOnCancelListener
```
public BottomSheet.Builder setOnCancelListener(android.content.DialogInterface.OnCancelListener listener)
```
    Sets the listener, which should be notified, when the bottom sheet, which is created by the builder, is canceled. If you are interested in listening for all cases where the bottom sheet is dismissed and not just when it is canceled, see setOnDismissListener.
    
    Parameters:
    
    listener - The listener, which should be set, as an instance of the type OnCancelListener, or null, if no listener should be set
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
    
    See Also:
    
    setOnDismissListener(android.content.DialogInterface.OnDismissListener)
  - setOnDismissListener
```
public final BottomSheet.Builder setOnDismissListener(android.content.DialogInterface.OnDismissListener listener)
```
    Sets the listener, which should be notified, when the bottom sheet, which is created by the builder, is dismissed for any reason.
    
    Parameters:
    
    listener - The listener, which should be set, as an instance of the type OnDismissListener, or null, if no listener should be set
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setOnKeyListener
```
public final BottomSheet.Builder setOnKeyListener(android.content.DialogInterface.OnKeyListener listener)
```
    Sets the listener, which should be notified, if a key is dispatched to the bottom sheet, which is created by the builder.
    
    Parameters:
    
    listener - The listener, which should be set, as an instance of the type OnKeyListener, or null, if no listener should be set
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setTitleColor
```
public final BottomSheet.Builder setTitleColor(int color)
```
    Sets the color of the title of the bottom sheet, which is created by the builder.
    
    Parameters:
    
    color - The color, which should be set, as an Integer value or -1, if no custom color should be set
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setItemColor
```
public final BottomSheet.Builder setItemColor(int color)
```
    Sets the color of the items of the bottom sheet, which is created by the builder.
    
    Parameters:
    
    color - The color, which should be set, as an Integer value or -1, if no custom color should be set
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setDividerColor
```
public final BottomSheet.Builder setDividerColor(int color)
```
    Sets the color of the dividers of the bottom sheet, which is created by the builder.
    
    Parameters:
    
    color - The color, which should be set, as an Integer value or -1, if no custom color should be set
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setBackground
```
public final BottomSheet.Builder setBackground(android.graphics.Bitmap background)
```
    Sets the background of the bottom sheet, which is created by the builder.
    
    Parameters:
    
    background - The background, which should be set, as an instance of the class Bitmap or null, if no custom background should be set
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setBackground
```
public final BottomSheet.Builder setBackground(int resourceId)
```
    Sets the background of the bottom sheet, which is created by the builder.
    
    Parameters:
    
    resourceId - The resource id of the background, which should be set, as an Integer value. The resource id must correspond to a valid drawable resource
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setBackgroundColor
```
public final BottomSheet.Builder setBackgroundColor(int color)
```
    Sets the background color of the bottom sheet, which is created by the builder.
    
    Parameters:
    
    color - The background color, which should be set, as an Integer value or -1, if no custom background color should be set
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setTitle
```
public final BottomSheet.Builder setTitle(java.lang.CharSequence title)
```
    Sets the title of the bottom sheet, which is created by the builder.
    
    Parameters:
    
    title - The title, which should be set, as an instance of the type CharSequence or null, if no title should be shown
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setTitle
```
public final BottomSheet.Builder setTitle(int resourceId)
```
    Sets the title of the bottom sheet, which is created by the builder.
    
    Parameters:
    
    resourceId - The resource id of the title, which should be set, as an Integer value. The resource id must correspond to a valid string resource
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setIcon
```
public final BottomSheet.Builder setIcon(android.graphics.Bitmap icon)
```
    Sets the icon of the bottom sheet, which is created by the builder.
    
    Parameters:
    
    icon - The icon, which should be set, as an instance of the class Bitmap or null, if no icon should be shown
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setIcon
```
public final BottomSheet.Builder setIcon(int resourceId)
```
    Sets the icon of the bottom sheet, which is created by the builder.
    
    Parameters:
    
    resourceId - The resource id of the icon, which should be set, as an Integer value. The resource id must correspond to a valid drawable resource
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setIconAttribute
```
public final BottomSheet.Builder setIconAttribute(int attributeId)
```
    Set the icon of the bottom sheet, which is created by the builder.
    
    Parameters:
    
    attributeId - The id of the theme attribute, which supplies the icon, which should be set, as an Integer value. The id must point to a valid drawable resource
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setView
```
public final BottomSheet.Builder setView(android.view.View view)
```
    Sets the custom view, which should be shown by the bottom sheet, which is created by the builder.
    
    Parameters:
    
    view - The view, which should be set, as an instance of the class View or null, if no custom view should be shown
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setView
```
public final BottomSheet.Builder setView(int resourceId)
```
    Sets the custom view, which should be shown by the bottom sheet, which is created by the builder.
    
    Parameters:
    
    resourceId - The resource id of the view, which should be set, as an Integer value. The resource id must correspond to a valid layout resource
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setCustomTitle
```
public final BottomSheet.Builder setCustomTitle(android.view.View view)
```
    Sets the custom view, which should be used to show the title of the bottom sheet, which is created by the builder.
    
    Parameters:
    
    view - The view, which should be set, as an instance of the class View or null, if no custom view should be used to show the title
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setCustomTitle
```
public final BottomSheet.Builder setCustomTitle(int resourceId)
```
    Sets the custom view, which should be used to show the title of the bottom sheet, which is created by the builder.
    
    Parameters:
    
    resourceId - The resource id of the view, which should be set, as an Integer value. The resource id must correspond to a valid layout resource
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setDragSensitivity
```
public final BottomSheet.Builder setDragSensitivity(float dragSensitivity)
```
    Sets the sensitivity, which specifies the distance after which dragging has an effect on the bottom sheet, in relation to an internal value range.
    
    Parameters:
    
    dragSensitivity - The drag sensitivity, which should be set, as a Float value. The drag sensitivity must be at lest 0 and at maximum 1
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setDimAmount
```
public final BottomSheet.Builder setDimAmount(float dimAmount)
```
    Sets the dim amount, which should be used to darken the area outside the bottom sheet, which is created by the builder.
    
    Parameters:
    
    dimAmount - The dim amount, which should be set, as a Float value. The dim amount must be at least 0 (fully transparent) and at maximum 1 (fully opaque)
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setWidth
```
public final BottomSheet.Builder setWidth(int width)
```
    Sets the width of the bottom sheet, which is created by the builder. The width is only used on tablet devices or in landscape mode.
    
    Parameters:
    
    width - The width, which should be set, in pixels as an Integer value. The width must be at least 1
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - addItem
```
public final BottomSheet.Builder addItem(int id,
                                         java.lang.CharSequence title)
```
    Adds a new item to the bottom sheet, which is created by the builder.
    
    Parameters:
    
    id - The id of the item, which should be added, as an Integer value. The id must be at least 0
    
    title - The title of the item, which should be added, as an instance of the type CharSequence. The title may neither be null, nor empty
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - addItem
```
public final BottomSheet.Builder addItem(int id,
                                         java.lang.CharSequence title,
                                         android.graphics.drawable.Drawable icon)
```
    Adds a new item to the bottom sheet, which is created by the builder.
    
    Parameters:
    
    id - The id of the item, which should be added, as an Integer value. The id must be at least 0
    
    title - The title of the item, which should be added, as an instance of the type CharSequence. The title may neither be null, nor empty
    
    icon - The icon of the item, which should be added, as an instance of the class Drawable, or null, if no item should be used
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - addItem
```
public final BottomSheet.Builder addItem(int id,
                                         int titleId)
```
    Adds a new item to the bottom sheet, which is created by the builder.
    
    Parameters:
    
    id - The id of the item, which should be added, as an Integer value. The id must be at least 0
    
    titleId - The resource id of the title of the item, which should be added, as an Integer value. The resource id must correspond to a valid string resource
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - addItem
```
public final BottomSheet.Builder addItem(int id,
                                         int titleId,
                                         int iconId)
```
    Adds a new item to the bottom sheet, which is created by the builder.
    
    Parameters:
    
    id - The id of the item, which should be added, as an Integer value. The id must be at least 0
    
    titleId - The resource id of the title of the item, which should be added, as an Integer value. The resource id must correspond to a valid string resource
    
    iconId - The resource id of the icon of the item, which should be added, as an Integer value. The resource id must correspond to a valid drawable resource
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - addDivider
```
public final BottomSheet.Builder addDivider()
```
    Adds a new divider to the bottom sheet, which is created by the builder.
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - addDivider
```
public final BottomSheet.Builder addDivider(java.lang.CharSequence title)
```
    Adds a new divider to the bottom sheet, which is created by the builder.
    
    Parameters:
    
    title - The title of the divider, which should be added, as an instance of the type CharSequence, or null, if no title should be used
  - addDivider
```
public final BottomSheet.Builder addDivider(int titleId)
```
    Adds a new divider to the bottom sheet, which is created by the builder.
    
    Parameters:
    
    titleId - The resource id of the title, which should be added, as an Integer value. The resource id must correspond to a valid string resource
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setItemEnabled
```
public final BottomSheet.Builder setItemEnabled(int index,
                                                boolean enabled)
```
    Sets, whether the item at a specific index should be enabled, or not.
    
    Parameters:
    
    index - The index of the item as an Integer value
    
    enabled - True, if the item should be enabled, false otherwise
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - setIntent
```
public final BottomSheet.Builder setIntent(android.app.Activity activity,
                                           android.content.Intent intent)
```
    Adds the apps, which are able to handle a specific intent, as items to the bottom sheet, which is created by the builder. This causes all previously added items to be removed. When an item is clicked, the corresponding app is started.
    
    Parameters:
    
    activity - The activity, the bottom sheet, which is created by the builder, belongs to, as an instance of the class Activity. The activity may not be null
    
    intent - The intent as an instance of the class Intent. The intent may not be null
    
    Returns:
    
    The builder, the method has been called upon, as an instance of the class BottomSheet.Builder
  - create
```
public final BottomSheet create()
```
    Creates a bottom sheet with the arguments, which have been supplied to the builder. Calling this method does not display the bottom sheet.
    
    Returns:
    
    The bottom sheet, which has been created as an instance of the class BottomSheet
  - show
```
public final BottomSheet show()
```
    Creates a bottom sheet with the arguments, which have been supplied to the builder and immediately displays it.
    
    Returns:
    
    The bottom sheet, which has been created, as an instance of the class BottomSheet
  - maximize
```
public final BottomSheet maximize()
```
    Creates a bottom sheet with the arguments, which have been supplied to the builder and immediately maximizes it.
    
    Returns:
    
    The bottom sheet, which has been created, as an instance of the class BottomSheet

Class BottomSheet.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Builder

Method Detail

getContext

setCancelable

setStyle

setOnItemClickListener

setOnItemLongClickListener

setOnMaximizeListener

setOnCancelListener

setOnDismissListener

setOnKeyListener

setTitleColor

setItemColor

setDividerColor

setBackground

setBackground

setBackgroundColor

setTitle

setTitle

setIcon

setIcon

setIconAttribute

setView

setView

setCustomTitle

setCustomTitle

setDragSensitivity

setDimAmount

setWidth

addItem

addItem

addItem

addItem

addDivider

addDivider

addDivider

setItemEnabled

setIntent

create

show

maximize