WelcomeConfiguration.Builder (welcome 1.4.1)

java.lang.Object
- com.stephentuso.welcome.WelcomeConfiguration.Builder

Enclosing class:: WelcomeConfiguration

public static class WelcomeConfiguration.Builder
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description

Builder(android.content.Context context)
Creates a new Builder

Constructors
Constructor and Description
`Builder(android.content.Context context)` Creates a new Builder

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WelcomeConfiguration.Builder`	`animateButtons(boolean animateButtons)` Set whether or not the buttons fade out/in when changing visibilty
`WelcomeConfiguration.Builder`	`backButtonNavigatesPages(boolean navigatesPages)` Set whether or not pressing the back button will move to the previous page in the welcome screen.
`WelcomeConfiguration.Builder`	`backButtonSkips(boolean backButtonSkips)` Only applies if skipping is allowed.
`WelcomeConfiguration.Builder`	`bottomLayout(WelcomeConfiguration.BottomLayout layout)` Set the bottom layout to be used
`WelcomeConfiguration`	`build()` Builds the configuration
`WelcomeConfiguration.Builder`	`canSkip(boolean canSkip)` Sets whether or not the welcome screen can be skipped.
`WelcomeConfiguration.Builder`	`defaultBackgroundColor(BackgroundColor backgroundColor)` Set the color to be used when no background color is specified for a page.
`WelcomeConfiguration.Builder`	`defaultBackgroundColor(int resId)` Set the color to be used when no background color is specified for a page Default is colorPrimary if available (support library or lollipop+), otherwise material blue 600
`WelcomeConfiguration.Builder`	`defaultDescriptionTypefacePath(java.lang.String typefacePath)` Set the path to a typeface (in assets) to be used by default for descriptions
`WelcomeConfiguration.Builder`	`defaultHeaderTypefacePath(java.lang.String typefacePath)` Set the path to a typeface (in assets) to be used by default for headers
`WelcomeConfiguration.Builder`	`defaultTitleTypefacePath(java.lang.String typefacePath)` Set the path to a typeface (in assets) to be used by default for titles
`WelcomeConfiguration.Builder`	`doneButtonTypefacePath(java.lang.String typefacePath)` Set the path to a typeface (in assets) to be used for the done button
`WelcomeConfiguration.Builder`	`exitAnimation(int exitAnimationResId)` Set the animation that is used when the welcome screen closes
`WelcomeConfiguration.Builder`	`page(WelcomePage page)` Adds a page, uses the default background color
`WelcomeConfiguration.Builder`	`showActionBarBackButton(boolean showBackButton)` If the action bar is enabled, setting this to true will cause the back button to be shown.
`WelcomeConfiguration.Builder`	`showNextButton(boolean showNextButton)` Set the visibility of the next button
`WelcomeConfiguration.Builder`	`showPrevButton(boolean showPrevButton)` Sets the visibility of the previous button (navigates back through the pages).
`WelcomeConfiguration.Builder`	`skipButtonTypefacePath(java.lang.String typefacePath)` Set the path to a typeface (in assets) to be used for the skip button
`WelcomeConfiguration.Builder`	`swipeToDismiss(boolean swipeToDismiss)` Enables or disables swipe to dismiss (disabled by default)
`WelcomeConfiguration.Builder`	`useCustomDoneButton(boolean useCustomDoneButton)` Indicate that a done button is going to be provided in a custom fragment.

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
    
    Parameters:
    
    context - Context object
- Method Detail
  - build
```
public WelcomeConfiguration build()
```
    Builds the configuration
    
    Returns:
    
    A WelcomeConfiguration with the parameters set on this object
  - swipeToDismiss
```
public WelcomeConfiguration.Builder swipeToDismiss(boolean swipeToDismiss)
```
    Enables or disables swipe to dismiss (disabled by default)
    
    Parameters:
    
    swipeToDismiss - True to enable swipe to dismiss, false to disable it
    
    Returns:
    
    this Builder object to allow method calls to be chained
  - canSkip
```
public WelcomeConfiguration.Builder canSkip(boolean canSkip)
```
    Sets whether or not the welcome screen can be skipped. Skipping is allowed by default
    
    Parameters:
    
    canSkip - True to allow skipping, false to disable it
    
    Returns:
    
    this Builder object to allow method calls to be chained
  - backButtonSkips
```
public WelcomeConfiguration.Builder backButtonSkips(boolean backButtonSkips)
```
    Only applies if skipping is allowed. Sets whether or not the back button can skip the welcome screen. This is enabled by default.
    
    Parameters:
    
    backButtonSkips - True to allow the back button to skip the welcome screen, false to disable it
    
    Returns:
    
    this Builder object to allow method calls to be chained
  - backButtonNavigatesPages
```
public WelcomeConfiguration.Builder backButtonNavigatesPages(boolean navigatesPages)
```
    Set whether or not pressing the back button will move to the previous page in the welcome screen. This is true by default
    
    Returns:
    
    this Builder object to allow method calls to be chained
  - animateButtons
```
public WelcomeConfiguration.Builder animateButtons(boolean animateButtons)
```
    Set whether or not the buttons fade out/in when changing visibilty
    
    Parameters:
    
    animateButtons - True to animate buttons, false to not
    
    Returns:
    
    this Builder object to allow method calls to be chained
  - useCustomDoneButton
```
public WelcomeConfiguration.Builder useCustomDoneButton(boolean useCustomDoneButton)
```
    Indicate that a done button is going to be provided in a custom fragment. Use WelcomeScreenFinisher.finish() in your button's onClickListener to close the welcome screen correctly.
    
    Parameters:
    
    useCustomDoneButton - Whether or not a done button will be present in the last fragment
    
    Returns:
    
    this Builder object to allow method calls to be chained
  - showNextButton
```
public WelcomeConfiguration.Builder showNextButton(boolean showNextButton)
```
    Set the visibility of the next button
    
    Parameters:
    
    showNextButton - Whether or not to show the next button
    
    Returns:
    
    this Builder object to allow method calls to be chained
  - showPrevButton
```
public WelcomeConfiguration.Builder showPrevButton(boolean showPrevButton)
```
    Sets the visibility of the previous button (navigates back through the pages). This shows in the same spot as the skip button. If this welcome screen can be skipped, setting this to true will hide the skip button on all but the first page.
    
    Parameters:
    
    showPrevButton - Whether or not to show the previous button
    
    Returns:
    
    this Builder object to allow method calls to be chained
  - showActionBarBackButton
```
public WelcomeConfiguration.Builder showActionBarBackButton(boolean showBackButton)
```
    If the action bar is enabled, setting this to true will cause the back button to be shown. Tapping it will cancel the welcome screen. (Show the action bar with a custom theme, set 'windowActionBar' to true and 'windowNoTitle' to false)
    
    Parameters:
    
    showBackButton - Whether or not to show the back button on the action bar
    
    Returns:
    
    this Builder object to allow method calls to be chained
  - skipButtonTypefacePath
```
public WelcomeConfiguration.Builder skipButtonTypefacePath(java.lang.String typefacePath)
```
    Set the path to a typeface (in assets) to be used for the skip button
    
    Parameters:
    
    typefacePath - The path to a typeface file in assets folder
    
    Returns:
    
    this Builder object to allow method calls to be chained
  - doneButtonTypefacePath
```
public WelcomeConfiguration.Builder doneButtonTypefacePath(java.lang.String typefacePath)
```
    Set the path to a typeface (in assets) to be used for the done button
    
    Parameters:
    
    typefacePath - The path to a typeface file in assets folder
    
    Returns:
    
    this Builder object to allow method calls to be chained
  - defaultTitleTypefacePath
```
public WelcomeConfiguration.Builder defaultTitleTypefacePath(java.lang.String typefacePath)
```
    Set the path to a typeface (in assets) to be used by default for titles
    
    Parameters:
    
    typefacePath - The path to a typeface file in assets folder
    
    Returns:
    
    this Builder object to allow method calls to be chained
  - defaultHeaderTypefacePath
```
public WelcomeConfiguration.Builder defaultHeaderTypefacePath(java.lang.String typefacePath)
```
    Set the path to a typeface (in assets) to be used by default for headers
    
    Parameters:
    
    typefacePath - The path to a typeface file in assets folder
    
    Returns:
    
    this Builder object to allow method calls to be chained
  - defaultDescriptionTypefacePath
```
public WelcomeConfiguration.Builder defaultDescriptionTypefacePath(java.lang.String typefacePath)
```
    Set the path to a typeface (in assets) to be used by default for descriptions
    
    Parameters:
    
    typefacePath - The path to a typeface file in assets folder
    
    Returns:
    
    this Builder object to allow method calls to be chained
  - exitAnimation
```
public WelcomeConfiguration.Builder exitAnimation(@AnimRes
                                                  int exitAnimationResId)
```
    Set the animation that is used when the welcome screen closes
    
    Parameters:
    
    exitAnimationResId - The resource id of the animation to use
    
    Returns:
    
    this Builder object to allow method calls to be chained
  - defaultBackgroundColor
```
public WelcomeConfiguration.Builder defaultBackgroundColor(@ColorRes
                                                           int resId)
```
    Set the color to be used when no background color is specified for a page Default is colorPrimary if available (support library or lollipop+), otherwise material blue 600
    
    Parameters:
    
    resId - The color resource id to use as the default background color
    
    Returns:
    
    this Builder object to allow method calls to be chained
  - defaultBackgroundColor
```
public WelcomeConfiguration.Builder defaultBackgroundColor(BackgroundColor backgroundColor)
```
    Set the color to be used when no background color is specified for a page. Default is colorPrimary if available (support library or lollipop+), otherwise material blue 600
    
    Parameters:
    
    backgroundColor - BackgroundColor to use as the default background color
    
    Returns:
    
    this Builder object to allow method calls to be chained
  - bottomLayout
```
public WelcomeConfiguration.Builder bottomLayout(WelcomeConfiguration.BottomLayout layout)
```
    Set the bottom layout to be used
    
    Parameters:
    
    layout - Bottom layout
    
    Returns:
    
    this Builder object to allow method calls to be chained
  - page
```
public WelcomeConfiguration.Builder page(WelcomePage page)
```
    Adds a page, uses the default background color
    
    Parameters:
    
    page - The page to add
    
    Returns:
    
    this Builder object to allow method calls to be chained

Class WelcomeConfiguration.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

swipeToDismiss

canSkip

backButtonSkips

backButtonNavigatesPages

animateButtons

useCustomDoneButton

showNextButton

showPrevButton

showActionBarBackButton

skipButtonTypefacePath

doneButtonTypefacePath

defaultTitleTypefacePath

defaultHeaderTypefacePath

defaultDescriptionTypefacePath

exitAnimation

defaultBackgroundColor

defaultBackgroundColor

bottomLayout

page