WelcomeConfiguration (welcome 1.4.1)

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

```
public class WelcomeConfiguration
extends java.lang.Object
```
Created by stephentuso on 11/15/15. All getters are in WelcomeConfiguration, all setters are in Builder

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class WelcomeConfiguration.BottomLayout

static class WelcomeConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`WelcomeConfiguration.BottomLayout`
`static class`	`WelcomeConfiguration.Builder`

Field Summary

Fields
Modifier and Type Field and Description

static int NO_ANIMATION_SET

Fields
Modifier and Type	Field and Description
`static int`	`NO_ANIMATION_SET`

Constructor Summary

Constructors
Constructor and Description

WelcomeConfiguration(WelcomeConfiguration.Builder builder)

Constructors
Constructor and Description
`WelcomeConfiguration(WelcomeConfiguration.Builder builder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Fragment`	`createFragment(int index)` Creates the fragment at the specified index
`int`	`firstPageIndex()` Get the index of the first page, dependent on if the layout is RTL
`boolean`	`getAnimateButtons()` Whether or not buttons should animate
`boolean`	`getBackButtonNavigatesPages()` Whether or not back button should navigate through pages
`boolean`	`getBackButtonSkips()` Whether or not back button should skip
`BackgroundColor[]`	`getBackgroundColors()` Get the background colors for the pages
`int`	`getBottomLayoutResId()` Get the layout res to be used for bottom of the welcome screen
`boolean`	`getCanSkip()` True if can skip, false if not
`android.content.Context`	`getContext()` Get context
`BackgroundColor`	`getDefaultBackgroundColor()` Get the default background color
`java.lang.String`	`getDefaultDescriptionTypefacePath()` Default typeface path for descriptions
`java.lang.String`	`getDefaultHeaderTypefacePath()` Default typeface path for headers
`java.lang.String`	`getDefaultTitleTypefacePath()` Default typeface path for titles
`java.lang.String`	`getDoneButtonTypefacePath()` Typeface path for done button
`int`	`getExitAnimation()` Get the resource id of the exit animation
`Fragment`	`getFragment(int index)` Get the fragment at the specified index
`WelcomePageList`	`getPages()`
`boolean`	`getShowActionBarBackButton()` Whether or not the action bar back button should be shown
`boolean`	`getShowNextButton()` Whether or not the next button should be shown
`boolean`	`getShowPrevButton()` Whether or not the previous button should be shown
`java.lang.String`	`getSkipButtonTypefacePath()` Typeface path for skip button
`boolean`	`getSwipeToDismiss()` Check if swipeToDismiss is enabled Returns false if SDK_INT is less than 11
`boolean`	`getUseCustomDoneButton()` Whether or not a custom done button should be used.
`boolean`	`isRtl()` Check if layout is RTL
`int`	`lastPageIndex()` Get the index of the last page, dependent on if the layout is RTL
`int`	`lastViewablePageIndex()` Get the index of the last viewable page, dependent on if the layout is RTL
`int`	`pageCount()` Get the total number of pages, will be +1 if swipeToDismiss is enabled
`int`	`viewablePageCount()` Get the number of viewable pages, not affected by swipeToDismiss

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

- Field Detail
  - NO_ANIMATION_SET
```
public static final int NO_ANIMATION_SET
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WelcomeConfiguration
```
public WelcomeConfiguration(WelcomeConfiguration.Builder builder)
```
- Method Detail
  - getContext
```
public android.content.Context getContext()
```
    Get context
    
    Returns:
    
    The context the builder was initialized with
  - getFragment
```
public Fragment getFragment(int index)
```
    Get the fragment at the specified index
    
    Parameters:
    
    index - the index of the fragment
    
    Returns:
    
    fragment
  - createFragment
```
public Fragment createFragment(int index)
```
    Creates the fragment at the specified index
    
    Parameters:
    
    index - the index of the fragment
    
    Returns:
    
    fragment
  - getDefaultBackgroundColor
```
public BackgroundColor getDefaultBackgroundColor()
```
    Get the default background color
    
    Returns:
    
    default color
  - getBackgroundColors
```
public BackgroundColor[] getBackgroundColors()
```
    Get the background colors for the pages
    
    Returns:
    
    array of background colors
  - pageCount
```
public int pageCount()
```
    Get the total number of pages, will be +1 if swipeToDismiss is enabled
    
    Returns:
    
    total number of pages
  - viewablePageCount
```
public int viewablePageCount()
```
    Get the number of viewable pages, not affected by swipeToDismiss
    
    Returns:
    
    number of viewable pages
  - getPages
```
public WelcomePageList getPages()
```
    Returns:
    
    list of pages
  - getBackButtonSkips
```
public boolean getBackButtonSkips()
```
    Whether or not back button should skip
    
    Returns:
    
    backButtonSkips
  - getBackButtonNavigatesPages
```
public boolean getBackButtonNavigatesPages()
```
    Whether or not back button should navigate through pages
    
    Returns:
    
    backButtonNavigatesPages
  - getSkipButtonTypefacePath
```
public java.lang.String getSkipButtonTypefacePath()
```
    Typeface path for skip button
    
    Returns:
    
    path to typeface in assets folder
  - getDoneButtonTypefacePath
```
public java.lang.String getDoneButtonTypefacePath()
```
    Typeface path for done button
    
    Returns:
    
    path to typeface in assets folder
  - getDefaultTitleTypefacePath
```
public java.lang.String getDefaultTitleTypefacePath()
```
    Default typeface path for titles
    
    Returns:
    
    path to typeface in assets folder
  - getDefaultHeaderTypefacePath
```
public java.lang.String getDefaultHeaderTypefacePath()
```
    Default typeface path for headers
    
    Returns:
    
    path to typeface in assets folder
  - getDefaultDescriptionTypefacePath
```
public java.lang.String getDefaultDescriptionTypefacePath()
```
    Default typeface path for descriptions
    
    Returns:
    
    path to typeface in assets folder
  - getCanSkip
```
public boolean getCanSkip()
```
    True if can skip, false if not
    
    Returns:
    
    canSkip
  - getSwipeToDismiss
```
public boolean getSwipeToDismiss()
```
    Check if swipeToDismiss is enabled Returns false if SDK_INT is less than 11
    
    Returns:
    
    swipeToDismiss
  - isRtl
```
public boolean isRtl()
```
    Check if layout is RTL
    
    Returns:
    
    true if RTL, false if not
  - firstPageIndex
```
public int firstPageIndex()
```
    Get the index of the first page, dependent on if the layout is RTL
    
    Returns:
    
    first page index
  - lastPageIndex
```
public int lastPageIndex()
```
    Get the index of the last page, dependent on if the layout is RTL
    
    Returns:
    
    last page index
  - lastViewablePageIndex
```
public int lastViewablePageIndex()
```
    Get the index of the last viewable page, dependent on if the layout is RTL
    
    Returns:
    
    last viewable page index
  - getExitAnimation
```
@AnimRes
public int getExitAnimation()
```
    Get the resource id of the exit animation
    
    Returns:
    
    animation resource id
  - getAnimateButtons
```
public boolean getAnimateButtons()
```
    Whether or not buttons should animate
    
    Returns:
    
    animate buttons
  - getUseCustomDoneButton
```
public boolean getUseCustomDoneButton()
```
    Whether or not a custom done button should be used. If true, the default done button should be hidden
    
    Returns:
    
    use custom done button
  - getShowNextButton
```
public boolean getShowNextButton()
```
    Whether or not the next button should be shown
    
    Returns:
    
    show next button
  - getShowPrevButton
```
public boolean getShowPrevButton()
```
    Whether or not the previous button should be shown
    
    Returns:
    
    show previous button
  - getShowActionBarBackButton
```
public boolean getShowActionBarBackButton()
```
    Whether or not the action bar back button should be shown
    
    Returns:
    
    show action bar back button
  - getBottomLayoutResId
```
@LayoutRes
public int getBottomLayoutResId()
```
    Get the layout res to be used for bottom of the welcome screen
    
    Returns:
    
    layout resource id

Class WelcomeConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_ANIMATION_SET

Constructor Detail

WelcomeConfiguration

Method Detail

getContext

getFragment

createFragment

getDefaultBackgroundColor

getBackgroundColors

pageCount

viewablePageCount

getPages

getBackButtonSkips

getBackButtonNavigatesPages

getSkipButtonTypefacePath

getDoneButtonTypefacePath

getDefaultTitleTypefacePath

getDefaultHeaderTypefacePath

getDefaultDescriptionTypefacePath

getCanSkip

getSwipeToDismiss

isRtl

firstPageIndex

lastPageIndex

lastViewablePageIndex

getExitAnimation

getAnimateButtons

getUseCustomDoneButton

getShowNextButton

getShowPrevButton

getShowActionBarBackButton

getBottomLayoutResId