HeaderDialogDecorator (library API)

java.lang.Object
- de.mrapp.android.dialog.decorator.AbstractDialogDecorator<MaterialDialog>
- - de.mrapp.android.dialog.decorator.HeaderDialogDecorator

All Implemented Interfaces:

Dialog, DialogDecorator, HeaderDialogDecorator
```
public class HeaderDialogDecorator
extends AbstractDialogDecorator<MaterialDialog>
implements HeaderDialogDecorator
```
A decorator, which allows to modify the view hierarchy of a dialog, which is designed according to Android 5's Material Design guidelines even on pre-Lollipop devices and may contain a header.

Since:

3.2.0

Constructor Summary

Constructors
Constructor and Description
`HeaderDialogDecorator(MaterialDialog dialog)` Creates a new decorator, which allows to modify the view hierarchy of a dialog, which is designed according to Android 5's Material Design guidelines even on pre-Lollipop devices and may contain a header.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`android.graphics.drawable.Drawable`	`getHeaderBackground()` Returns the background of the dialog's header.
`int`	`getHeaderDividerColor()` Returns the color of the divider of the dialog's header.
`int`	`getHeaderHeight()` Returns the height of the dialog's header.
`android.graphics.drawable.Drawable`	`getHeaderIcon()` Returns the icon of the dialog's header.
`boolean`	`isHeaderDividerShown()` Returns, whether the divider of the dialog's header is shown, or not.
`boolean`	`isHeaderShown()` Returns, whether the dialog's header is shown, or not.
`protected void`	`onAttach(android.view.View view)` The method, which is invoked, when the decorator is attached to the view hierarchy.
`protected void`	`onDetach()` The method, which is invoked, when the decorator is detached from the view hierarchy.
`void`	`onRestoreInstanceState(android.os.Bundle savedInstanceState)` The method, which is invoked in order to restore the state, which has previously stored within a bundle.
`void`	`onSaveInstanceState(android.os.Bundle outState)` The method, which is invoked in order to stores the decorator's state.
`void`	`setHeaderBackground(android.graphics.Bitmap background)` Sets the background of the dialog's header.
`void`	`setHeaderBackground(int resourceId)` Sets the background of the dialog's header.
`void`	`setHeaderBackgroundColor(int color)` Sets the background color of the dialog's header.
`void`	`setHeaderDividerColor(int color)` Sets the color of the divider of the dialog's header.
`void`	`setHeaderHeight(int height)` Sets the height of the dialog's header.
`void`	`setHeaderIcon(android.graphics.Bitmap icon)` Sets the icon of the dialog's header.
`void`	`setHeaderIcon(int resourceId)` Sets the icon of the dialog's header.
`void`	`showHeader(boolean show)` Sets, whether the dialog's header should be shown, or not.
`void`	`showHeaderDivider(boolean show)` Sets, whether the divider of the dialog's header should be shown, or not.

Methods inherited from class de.mrapp.android.dialog.decorator.AbstractDialogDecorator
attach, detach, getContext, getDialog, getView

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

Methods inherited from interface de.mrapp.android.dialog.model.Dialog
getContext

- Constructor Detail
  - HeaderDialogDecorator
```
public HeaderDialogDecorator(MaterialDialog dialog)
```
    Creates a new decorator, which allows to modify the view hierarchy of a dialog, which is designed according to Android 5's Material Design guidelines even on pre-Lollipop devices and may contain a header.
    
    Parameters:
    
    dialog - The dialog, whose view hierarchy should be modified by the decorator, as an instance of the type MaterialDialog. The dialog may not be null
- Method Detail
  - isHeaderShown
```
public final boolean isHeaderShown()
```
    Description copied from interface: HeaderDialogDecorator
    
    Returns, whether the dialog's header is shown, or not.
    
    Specified by:
    
    isHeaderShown in interface HeaderDialogDecorator
    
    Returns:
    
    True, if the dialog's header is shown, false otherwise
  - showHeader
```
public final void showHeader(boolean show)
```
    Description copied from interface: HeaderDialogDecorator
    
    Sets, whether the dialog's header should be shown, or not.
    
    Specified by:
    
    showHeader in interface HeaderDialogDecorator
    
    Parameters:
    
    show - True, if the dialog's header should be shown, false otherwise
  - getHeaderHeight
```
public final int getHeaderHeight()
```
    Description copied from interface: HeaderDialogDecorator
    
    Returns the height of the dialog's header.
    
    Specified by:
    
    getHeaderHeight in interface HeaderDialogDecorator
    
    Returns:
    
    The height of the dialog's header in pixels as an Integer value
  - setHeaderHeight
```
public final void setHeaderHeight(int height)
```
    Description copied from interface: HeaderDialogDecorator
    
    Sets the height of the dialog's header.
    
    Specified by:
    
    setHeaderHeight in interface HeaderDialogDecorator
    
    Parameters:
    
    height - The height, which should be set, in pixels as an Integer value. The height must be at least 0
  - getHeaderBackground
```
public final android.graphics.drawable.Drawable getHeaderBackground()
```
    Description copied from interface: HeaderDialogDecorator
    
    Returns the background of the dialog's header.
    
    Specified by:
    
    getHeaderBackground in interface HeaderDialogDecorator
    
    Returns:
    
    The background of the dialog's header as an instance of the class Drawable
  - setHeaderBackground
```
public final void setHeaderBackground(android.graphics.Bitmap background)
```
    Description copied from interface: HeaderDialogDecorator
    
    Sets the background of the dialog's header.
    
    Specified by:
    
    setHeaderBackground in interface HeaderDialogDecorator
    
    Parameters:
    
    background - The background, which should be set, as an instance of the class Bitmap or null, if no background should be shown
  - setHeaderBackground
```
public final void setHeaderBackground(int resourceId)
```
    Description copied from interface: HeaderDialogDecorator
    
    Sets the background of the dialog's header.
    
    Specified by:
    
    setHeaderBackground in interface HeaderDialogDecorator
    
    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
  - setHeaderBackgroundColor
```
public final void setHeaderBackgroundColor(int color)
```
    Description copied from interface: HeaderDialogDecorator
    
    Sets the background color of the dialog's header.
    
    Specified by:
    
    setHeaderBackgroundColor in interface HeaderDialogDecorator
    
    Parameters:
    
    color - The background color, which should be set, as an Integer value
  - getHeaderIcon
```
public final android.graphics.drawable.Drawable getHeaderIcon()
```
    Description copied from interface: HeaderDialogDecorator
    
    Returns the icon of the dialog's header.
    
    Specified by:
    
    getHeaderIcon in interface HeaderDialogDecorator
    
    Returns:
    
    The icon of the dialog's header as an instance of the class Drawable or null, if no icon has been set
  - setHeaderIcon
```
public final void setHeaderIcon(android.graphics.Bitmap icon)
```
    Description copied from interface: HeaderDialogDecorator
    
    Sets the icon of the dialog's header.
    
    Specified by:
    
    setHeaderIcon in interface HeaderDialogDecorator
    
    Parameters:
    
    icon - The icon, which should be set, as an instance of the class Bitmap or null, if no icon should be set
  - setHeaderIcon
```
public final void setHeaderIcon(int resourceId)
```
    Description copied from interface: HeaderDialogDecorator
    
    Sets the icon of the dialog's header.
    
    Specified by:
    
    setHeaderIcon in interface HeaderDialogDecorator
    
    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
  - getHeaderDividerColor
```
public final int getHeaderDividerColor()
```
    Description copied from interface: HeaderDialogDecorator
    
    Returns the color of the divider of the dialog's header.
    
    Specified by:
    
    getHeaderDividerColor in interface HeaderDialogDecorator
    
    Returns:
    
    The color of the divider of the dialog's header as an Integer value
  - setHeaderDividerColor
```
public final void setHeaderDividerColor(int color)
```
    Description copied from interface: HeaderDialogDecorator
    
    Sets the color of the divider of the dialog's header.
    
    Specified by:
    
    setHeaderDividerColor in interface HeaderDialogDecorator
    
    Parameters:
    
    color - The color, which should be set, as an Integer value
  - isHeaderDividerShown
```
public final boolean isHeaderDividerShown()
```
    Description copied from interface: HeaderDialogDecorator
    
    Returns, whether the divider of the dialog's header is shown, or not.
    
    Specified by:
    
    isHeaderDividerShown in interface HeaderDialogDecorator
    
    Returns:
    
    True, if the divider of the dialog's header is shown, false otherwise
  - showHeaderDivider
```
public final void showHeaderDivider(boolean show)
```
    Description copied from interface: HeaderDialogDecorator
    
    Sets, whether the divider of the dialog's header should be shown, or not.
    
    Specified by:
    
    showHeaderDivider in interface HeaderDialogDecorator
    
    Parameters:
    
    show - True, if the divider of the dialog's header should be shown, false otherwise
  - onSaveInstanceState
```
public final void onSaveInstanceState(android.os.Bundle outState)
```
    Description copied from interface: DialogDecorator
    
    The method, which is invoked in order to stores the decorator's state.
    
    Specified by:
    
    onSaveInstanceState in interface DialogDecorator
    
    Parameters:
    
    outState - The bundle, the decorator's state should be stored within, as an instance of the class Bundle. The bundle may not be null
  - onRestoreInstanceState
```
public final void onRestoreInstanceState(android.os.Bundle savedInstanceState)
```
    Description copied from interface: DialogDecorator
    
    The method, which is invoked in order to restore the state, which has previously stored within a bundle.
    
    Specified by:
    
    onRestoreInstanceState in interface DialogDecorator
    
    Parameters:
    
    savedInstanceState - The bundle, which has been used to store the state, as an instance of the class Bundle. The bundle may not be null
  - onAttach
```
protected final void onAttach(android.view.View view)
```
    Description copied from class: AbstractDialogDecorator
    
    The method, which is invoked, when the decorator is attached to the view hierarchy.
    
    Specified by:
    
    onAttach in class AbstractDialogDecorator<MaterialDialog>
    
    Parameters:
    
    view - The root view of the dialog, which is modified by the decorator, as an instance of the class View. The view may not be null
  - onDetach
```
protected final void onDetach()
```
    Description copied from class: AbstractDialogDecorator
    
    The method, which is invoked, when the decorator is detached from the view hierarchy.
    
    Specified by:
    
    onDetach in class AbstractDialogDecorator<MaterialDialog>

Class HeaderDialogDecorator

Constructor Summary

Method Summary

Methods inherited from class de.mrapp.android.dialog.decorator.AbstractDialogDecorator

Methods inherited from class java.lang.Object

Methods inherited from interface de.mrapp.android.dialog.model.Dialog

Constructor Detail

HeaderDialogDecorator

Method Detail

isHeaderShown

showHeader

getHeaderHeight

setHeaderHeight

getHeaderBackground

setHeaderBackground

setHeaderBackground

setHeaderBackgroundColor

getHeaderIcon

setHeaderIcon

setHeaderIcon

getHeaderDividerColor

setHeaderDividerColor

isHeaderDividerShown

showHeaderDivider

onSaveInstanceState

onRestoreInstanceState

onAttach

onDetach