IntroActivity (library API)

Constructor Summary

Constructors
Constructor and Description

IntroActivity()

Constructors
Constructor and Description
`IntroActivity()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`disableFinalButton(boolean disabled)` Hides and disables the final button.
`void`	`disableLeftButton(boolean disabled)` Hides and disables the left button.
`void`	`disableRightButton(boolean disabled)` Hides and disables the right button.
`void`	`enableProgressIndicatorAnimations(boolean enableAnimations)` Enables or disables progress indicator animations
`boolean`	`finalButtonIsDisabled()` Returns whether or not the left button is currently disabled and hidden.
`protected abstract IntroButton.Behaviour`	`generateFinalButtonBehaviour()` Called by `onCreate(Bundle)` to generate the behaviour of the final button.
`protected abstract java.util.Collection<Page>`	`generatePages(android.os.Bundle savedInstanceState)` Called by `onCreate(Bundle)` to generate the pages to display in this activity.
`Page`	`getCurrentPage()`
`IntroButton.Appearance`	`getFinalButtonAppearance()`
`IntroButton.Behaviour`	`getFinalButtonBehaviour()`
`android.graphics.drawable.Drawable`	`getFinalButtonIcon(java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)` Returns the icon to display in the final button for a particular behaviour.
`java.lang.CharSequence`	`getFinalButtonText(java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)` Returns the text to display in the final button for a particular behaviour class.
`int`	`getFinalButtonTextColor()` Returns the color of the text in the final button.
`float`	`getFinalButtonTextSize()` Returns the size of the text in the final button.
`Page`	`getFirstPage()`
`int`	`getIndexOfCurrentPage()`
`int`	`getIndexOfPage(Page page)` Returns the index of the specified page, or -1 if the page is not in this activity.
`Page`	`getLastPage()`
`IntroButton.Appearance`	`getLeftButtonAppearance()`
`IntroButton.Behaviour`	`getLeftButtonBehaviour()`
`android.graphics.drawable.Drawable`	`getLeftButtonIcon(java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)` Returns the icon to display in the left button for a particular behaviour.
`java.lang.CharSequence`	`getLeftButtonText(java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)` Returns the text to display in the left button for a particular behaviour class.
`int`	`getLeftButtonTextColor()` Returns the color of the text in the left button.
`float`	`getLeftButtonTextSize()` Returns the size of the text in the left button.
`Page`	`getPage(int pageIndex)` Returns the page at the specified index.
`java.util.Collection<Page>`	`getPages()` Returns a reference to the pages of this activity, as an unmodifiable collection.
`LockableViewPager.LockMode`	`getPagingLockMode()`
`SelectionIndicator`	`getProgressIndicator()`
`IntroButton.Appearance`	`getRightButtonAppearance()`
`IntroButton.Behaviour`	`getRightButtonBehaviour()`
`android.graphics.drawable.Drawable`	`getRightButtonIcon(java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)` Returns the icon to display in the right button for a particular behaviour.
`java.lang.CharSequence`	`getRightButtonText(java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)` Returns the text to display in the right button for a particular behaviour class.
`int`	`getRightButtonTextColor()` Returns the color of the text in the right button.
`float`	`getRightButtonTextSize()` Returns the size of the text in the right button.
`android.widget.RelativeLayout`	`getRootView()`
`void`	`goToFirstPage()` Displays the first page, if not already displayed.
`void`	`goToLastPage()` Displays the last page, if not already displayed.
`void`	`goToNextPage()` Displays the next page, if not already displayed.
`void`	`goToPage(int pageIndex)` Changes which page is currently displayed.
`void`	`goToPreviousPage()` Displays the previous page, if not already displayed.
`void`	`hideLeftButtonOnLastPage(boolean hideButton)` Sets whether or not the left button should be hidden when the last page is displayed.
`void`	`hideStatusBar()` Hides the status bar background but continues to display the icons.
`boolean`	`leftButtonIsDisabled()` Returns whether or not the left button is currently disabled and hidden.
`boolean`	`leftButtonIsHiddenOnLastPage()` Returns whether or not the left button will be hidden when the last page is displayed.
`int`	`numberOfPages()`
`void`	`onBackPressed()` Called when the back button is pressed.
`protected void`	`onCreate(android.os.Bundle savedInstanceState)` Initialises the UI and behaviour of this activity.
`void`	`onItemAdded(ArrayListWithCallbacks list, java.lang.Object itemAdded, int index)`
`void`	`onItemRemoved(ArrayListWithCallbacks list, java.lang.Object itemRemoved, int index)`
`void`	`onListCleared(ArrayListWithCallbacks list)`
`void`	`onPageScrolled(int position, float positionOffset, int positionOffsetPixels)`
`void`	`onPageScrollStateChanged(int state)`
`void`	`onPageSelected(int position)`
`protected void`	`onSaveInstanceState(android.os.Bundle outState)`
`boolean`	`progressIndicatorAnimationsAreEnabled()`
`boolean`	`rightButtonIsDisabled()` Returns whether or not the right button is currently disabled and hidden.
`void`	`setFinalButtonAppearance(IntroButton.Appearance appearance)` Sets the appearance of the final button.
`void`	`setFinalButtonBehaviour(IntroButton.Behaviour behaviour)` Sets the behaviour of the final button.
`void`	`setFinalButtonIcon(android.graphics.drawable.Drawable icon, java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)` Sets the icon to display in the final button for a single behaviour class.
`void`	`setFinalButtonOnClickListener(android.view.View.OnClickListener l)` Register a callback to be invoked when the final button is clicked.
`void`	`setFinalButtonText(java.lang.CharSequence text, java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)` Sets the text to display in the final button for a single behaviour class.
`void`	`setFinalButtonTextColor(int color)` Sets the color of the text in the final button.
`void`	`setFinalButtonTextSize(float sizeSp)` Sets the size of the text in the final button.
`void`	`setFinalButtonTypeface(android.graphics.Typeface tf)` Sets the typeface and style in which the text of the final button should be displayed.
`void`	`setFinalButtonTypeface(android.graphics.Typeface tf, int style)` Sets the typeface and style in which the text of the final button should be displayed.
`void`	`setLeftButtonAppearance(IntroButton.Appearance appearance)` Sets the appearance of the left button.
`void`	`setLeftButtonBehaviour(IntroButton.Behaviour behaviour)` Sets the behaviour of the left button.
`void`	`setLeftButtonIcon(android.graphics.drawable.Drawable icon, java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)` Sets the icon to display in the left button for a single behaviour class.
`void`	`setLeftButtonOnClickListener(android.view.View.OnClickListener l)` Register a callback to be invoked when the left button is clicked.
`void`	`setLeftButtonText(java.lang.CharSequence text, java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)` Sets the text to display in the left button for a single behaviour class.
`void`	`setLeftButtonTextColor(int color)` Sets the color of the text in the left button.
`void`	`setLeftButtonTextSize(float sizeSp)` Sets the size of the text in the left button.
`void`	`setLeftButtonTypeface(android.graphics.Typeface tf)` Sets the typeface and style in which the text of the left button should be displayed.
`void`	`setLeftButtonTypeface(android.graphics.Typeface tf, int style)` Sets the typeface and style in which the text of the left button should be displayed.
`void`	`setPageTransformer(boolean reverseDrawingOrder, ViewPager.PageTransformer transformer)` Sets the PageTransformer which will be used to the pages of this intro screen when scrolled.
`void`	`setPagingLockMode(LockableViewPager.LockMode lockMode)` Sets the paging lock mode.
`void`	`setProgressIndicator(SelectionIndicator selectionIndicator)` Sets the selection indicator to show the user's progress through the activity.
`void`	`setRightButtonAppearance(IntroButton.Appearance appearance)` Sets the appearance of the right button.
`void`	`setRightButtonBehaviour(IntroButton.Behaviour behaviour)` Sets the behaviour of the right button when clicked.
`void`	`setRightButtonIcon(android.graphics.drawable.Drawable icon, java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)` Sets the icon to display in the right button for a single behaviour class.
`void`	`setRightButtonOnClickListener(android.view.View.OnClickListener l)` Register a callback to be invoked when the right button is clicked.
`void`	`setRightButtonText(java.lang.CharSequence text, java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)` Sets the text to display in the right button for a single behaviour class.
`void`	`setRightButtonTextColor(int color)` Sets the text color of the right button.
`void`	`setRightButtonTextSize(float sizeSp)` Sets the size of the text in the right button.
`void`	`setRightButtonTypeface(android.graphics.Typeface tf)` Sets the typeface and style in which the text of the right button should be displayed.
`void`	`setRightButtonTypeface(android.graphics.Typeface tf, int style)` Sets the typeface and style in which the text of the right button should be displayed.
`void`	`showStatusBar()` Shows the status bar background and prevents views from being drawn behind the status bar (including existing views).

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

- Constructor Detail
  - IntroActivity
```
public IntroActivity()
```
- Method Detail
  - onCreate
```
protected void onCreate(android.os.Bundle savedInstanceState)
```
    Initialises the UI and behaviour of this activity. This method calls generatePages(Bundle) to create the pages to display in this activity.
    
    Parameters:
    
    savedInstanceState - if this activity is being re-initialized after previously being shut down, then this Bundle contains the data this activity most recently saved in onSaveInstanceState(Bundle), otherwise null
  - onSaveInstanceState
```
protected void onSaveInstanceState(android.os.Bundle outState)
```
  - onBackPressed
```
public void onBackPressed()
```
    Called when the back button is pressed. If this activity is currently displaying the first page or the left lock mode prevents commands, then the default back behaviour occurs. Otherwise, the previous page is displayed.
  - generatePages
```
protected abstract java.util.Collection<Page> generatePages(android.os.Bundle savedInstanceState)
```
    Called by onCreate(Bundle) to generate the pages to display in this activity. The returned collection is copied, so further changes to the collection will have no effect after this method returns. The natural ordering of the returned collection is used for the order of the pages.
    
    Parameters:
    
    savedInstanceState - if this activity is being re-initialized after previously being shut down, then this Bundle contains the data this activity most recently saved in onSaveInstanceState(Bundle), otherwise null
    
    Returns:
    
    the collection of Page elements to display, not null
  - generateFinalButtonBehaviour
```
protected abstract IntroButton.Behaviour generateFinalButtonBehaviour()
```
    Called by onCreate(Bundle) to generate the behaviour of the final button. This behaviour can be changed later using #setFinalButtonBehaviour(Behaviour). The IntroButton.ProgressToNextActivity class is designed to simplify the implementation.
    
    Returns:
    
    the behaviour to use for the final button, not null
  - hideStatusBar
```
public final void hideStatusBar()
```
    Hides the status bar background but continues to display the icons. Views and ViewGroups which declare the android:fitsSystemWindows="false" attribute will draw to the top of the screen. The effect of this method varies depending on the current SDK version.
  - showStatusBar
```
public final void showStatusBar()
```
    Shows the status bar background and prevents views from being drawn behind the status bar (including existing views). The primary dark color of the current theme will be used for the status bar color (on SDK version 21 and up). If the current theme does not specify a primary dark color, the status bar will be colored black.
  - getRootView
```
public final android.widget.RelativeLayout getRootView()
```
    Returns:
    
    a reference to the top most view of this activity
  - setPageTransformer
```
public final void setPageTransformer(boolean reverseDrawingOrder,
                                     ViewPager.PageTransformer transformer)
```
    Sets the PageTransformer which will be used to the pages of this intro screen when scrolled.
    
    Parameters:
    
    reverseDrawingOrder - true if the supplied PageTransformer requires page views to be drawn from last to first instead of first to last
    
    transformer - the PageTransformer that will modify each page's animation properties
  - getPages
```
public final java.util.Collection<Page> getPages()
```
    Returns a reference to the pages of this activity, as an unmodifiable collection.
    
    Returns:
    
    the pages of this activity
  - getPage
```
public final Page getPage(int pageIndex)
```
    Returns the page at the specified index.
    
    Parameters:
    
    pageIndex - the index of the page to return, counting from zero
    
    Returns:
    
    the page at index
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the index exceeds the size of the page dataset
  - getCurrentPage
```
public final Page getCurrentPage()
```
    Returns:
    
    the Page currently being displayed
  - getFirstPage
```
public final Page getFirstPage()
```
    Returns:
    
    the first Page of this activity
  - getLastPage
```
public final Page getLastPage()
```
    Returns:
    
    the last Page of this activity
  - getIndexOfPage
```
public final int getIndexOfPage(Page page)
```
    Returns the index of the specified page, or -1 if the page is not in this activity.
    
    Parameters:
    
    page - the Page to get the index of
    
    Returns:
    
    the index of page, counting from zero
  - getIndexOfCurrentPage
```
public final int getIndexOfCurrentPage()
```
    Returns:
    
    the index of the page currently being displayed, counting from zero
  - goToPage
```
public final void goToPage(int pageIndex)
```
    Changes which page is currently displayed.
    
    Parameters:
    
    pageIndex - the index of the page to display, counting from zero
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the index exceeds the size of the page dataset
  - goToLastPage
```
public final void goToLastPage()
```
    Displays the last page, if not already displayed.
  - goToFirstPage
```
public final void goToFirstPage()
```
    Displays the first page, if not already displayed.
  - goToNextPage
```
public final void goToNextPage()
```
    Displays the next page, if not already displayed.
  - goToPreviousPage
```
public final void goToPreviousPage()
```
    Displays the previous page, if not already displayed.
  - numberOfPages
```
public final int numberOfPages()
```
    Returns:
    
    the current number of pages in this activity
  - setPagingLockMode
```
public final void setPagingLockMode(LockableViewPager.LockMode lockMode)
```
    Sets the paging lock mode. This can be used to prevent the user from navigating to another page by swiping, pressing buttons, or both.
    
    Parameters:
    
    lockMode - the lock mode to use, not null
  - getPagingLockMode
```
public final LockableViewPager.LockMode getPagingLockMode()
```
    Returns:
    
    the current lock mode for paging right
  - setProgressIndicator
```
public void setProgressIndicator(SelectionIndicator selectionIndicator)
```
    Sets the selection indicator to show the user's progress through the activity. The provides selection indicator must be a subclass of View.
    
    Parameters:
    
    selectionIndicator - the selection indicator to use, null to clear any existing indicator
  - getProgressIndicator
```
public SelectionIndicator getProgressIndicator()
```
    Returns:
    
    the selection indicator showing the user's progress through the activity, null if there is none
  - enableProgressIndicatorAnimations
```
public void enableProgressIndicatorAnimations(boolean enableAnimations)
```
    Enables or disables progress indicator animations
    
    Parameters:
    
    enableAnimations - true to enable animations, false to disable them
  - progressIndicatorAnimationsAreEnabled
```
public boolean progressIndicatorAnimationsAreEnabled()
```
    Returns:
    
    true if progress indicator animations are enabled, false otherwise
  - setLeftButtonBehaviour
```
public final void setLeftButtonBehaviour(IntroButton.Behaviour behaviour)
```
    Sets the behaviour of the left button. This is distinct from the on-click behaviour, which can be set using #setLeftButtonOnClickListener(OnClickListener). Predefined behaviours are provided in the IntroButton class, however custom behaviours are accepted. To use a custom behaviour, implement IntroButton.Behaviour and pass an instance of the implementation to this method. Alternatively, subclassing IntroButton.BehaviourAdapter simplifies the implementation and eliminates boilerplate code.
    
    Parameters:
    
    behaviour - the behaviour to use when left button is pressed, not null
  - getLeftButtonBehaviour
```
public final IntroButton.Behaviour getLeftButtonBehaviour()
```
    Returns:
    
    the current behaviour of the left button
  - setLeftButtonAppearance
```
public final void setLeftButtonAppearance(IntroButton.Appearance appearance)
```
    Sets the appearance of the left button.
    
    Parameters:
    
    appearance - the predefined appearance to use, not null
  - getLeftButtonAppearance
```
public final IntroButton.Appearance getLeftButtonAppearance()
```
    Returns:
    
    the current Appearance of the left button
  - setLeftButtonText
```
public final void setLeftButtonText(java.lang.CharSequence text,
                                    java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)
```
    Sets the text to display in the left button for a single behaviour class. The current appearance of the button determines whether or not the text will actually be displayed. Although null is accepted, changing the button appearance using #setLeftButtonAppearance(Appearance) is the preferred method of showing no text.
    
    Parameters:
    
    text - the text label to display
    
    behaviourClass - the behaviour class to set the label for, null to use the class of the current behaviour
  - getLeftButtonText
```
public final java.lang.CharSequence getLeftButtonText(java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)
```
    Returns the text to display in the left button for a particular behaviour class.
    
    Parameters:
    
    behaviourClass - the behaviour class to query the text against, null to use the class of the current behaviour
    
    Returns:
    
    the text for behaviourClass, null if there is none
  - setLeftButtonIcon
```
public final void setLeftButtonIcon(android.graphics.drawable.Drawable icon,
                                    java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)
```
    Sets the icon to display in the left button for a single behaviour class. The current appearance of the button determines whether or not the icon will actually be displayed, and where it will be located. Although null is accepted, changing the button appearance using #setLeftButtonAppearance(Appearance) is the preferred method of showing no icon.
    
    Parameters:
    
    icon - the icon to display
    
    behaviourClass - the behaviour class to set the icon for, null to use the class of the current appearance
  - getLeftButtonIcon
```
public final android.graphics.drawable.Drawable getLeftButtonIcon(java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)
```
    Returns the icon to display in the left button for a particular behaviour.
    
    Parameters:
    
    behaviourClass - the behaviour class to query the icon against, null to use the class of the current behaviour
    
    Returns:
    
    the icon for behaviourClass, null if there is none
  - setLeftButtonTextColor
```
public final void setLeftButtonTextColor(int color)
```
    Sets the color of the text in the left button. The color is common to all behaviours.
    
    Parameters:
    
    color - the color to use, as an ARGB hex code
  - getLeftButtonTextColor
```
public final int getLeftButtonTextColor()
```
    Returns the color of the text in the left button. The color is common to all behaviours.
    
    Returns:
    
    the text color, as an ARGB hex code
  - setLeftButtonTextSize
```
public final void setLeftButtonTextSize(float sizeSp)
```
    Sets the size of the text in the left button. The size is common to all behaviours.
    
    Parameters:
    
    sizeSp - the size to use, measured in scaled-pixels
  - getLeftButtonTextSize
```
public final float getLeftButtonTextSize()
```
    Returns the size of the text in the left button. The size is common to all behaviours.
    
    Returns:
    
    the text size, measured in pixels
  - setLeftButtonTypeface
```
public final void setLeftButtonTypeface(android.graphics.Typeface tf,
                                        int style)
```
    Sets the typeface and style in which the text of the left button should be displayed. Turns on the fake bold and italic bits in the Paint if the Typeface that you provided does not have all the bits in the style that you specified.
    
    Parameters:
    
    tf - the typeface to use
    
    style - style for the typeface
  - setLeftButtonTypeface
```
public final void setLeftButtonTypeface(android.graphics.Typeface tf)
```
    Sets the typeface and style in which the text of the left button should be displayed. Turns on the fake bold and italic bits in the Paint if the Typeface that you provided does not have all the bits in the style that you specified.
    
    Parameters:
    
    tf - the typeface to use
  - setLeftButtonOnClickListener
```
public final void setLeftButtonOnClickListener(android.view.View.OnClickListener l)
```
    Register a callback to be invoked when the left button is clicked. If the button is not clickable, it becomes clickable. Registering for on-click events does not prevent the left button from performing its predefined behaviour.
    
    Parameters:
    
    l - the callback that will run, null to clear the existing listener
  - disableLeftButton
```
public final void disableLeftButton(boolean disabled)
```
    Hides and disables the left button. This overrides any
    
    Parameters:
    
    disabled - whether or not the button should be hidden/disabled
  - leftButtonIsDisabled
```
public final boolean leftButtonIsDisabled()
```
    Returns whether or not the left button is currently disabled and hidden.
    
    Returns:
    
    true if disabled and hidden, false otherwise
  - hideLeftButtonOnLastPage
```
public final void hideLeftButtonOnLastPage(boolean hideButton)
```
    Sets whether or not the left button should be hidden when the last page is displayed. If disableFinalButton(boolean) has been used to disable the left button then calling this method will not display the left button. The setting will still be recorded so that if the button is later enabled then the last page behaviour is retained.
    
    Parameters:
    
    hideButton - true to hide the left button on the last page, false to show it
  - leftButtonIsHiddenOnLastPage
```
public final boolean leftButtonIsHiddenOnLastPage()
```
    Returns whether or not the left button will be hidden when the last page is displayed. This method ignores whether or not the button is disabled/enabled.
    
    Returns:
    
    true if the left button will be hidden when the last page is displayed, false otherwise
  - setRightButtonBehaviour
```
public final void setRightButtonBehaviour(IntroButton.Behaviour behaviour)
```
    Sets the behaviour of the right button when clicked. This is distinct from the on-click behaviour, which can be set using #setRightButtonOnClickListener(OnClickListener). Predefined behaviours are provided in the IntroButton class, however custom behaviours are accepted. To use a custom behaviour, implement IntroButton.Behaviour and pass an instance of the implementation to this method. Alternatively, subclassing IntroButton.BehaviourAdapter simplifies the implementation and eliminates boilerplate code.
    
    Parameters:
    
    behaviour - the behaviour to use when the right button is pressed, not null
  - getRightButtonBehaviour
```
public final IntroButton.Behaviour getRightButtonBehaviour()
```
    Returns:
    
    the current Behaviour of the right button
  - setRightButtonAppearance
```
public final void setRightButtonAppearance(IntroButton.Appearance appearance)
```
    Sets the appearance of the right button.
    
    Parameters:
    
    appearance - the predefined appearance to use, not null
  - getRightButtonAppearance
```
public final IntroButton.Appearance getRightButtonAppearance()
```
    Returns:
    
    the current Appearance of the right button
  - setRightButtonText
```
public final void setRightButtonText(java.lang.CharSequence text,
                                     java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)
```
    Sets the text to display in the right button for a single behaviour class. The current appearance of the button determines whether or not the text will actually be displayed. Although null is accepted, changing the button appearance using #setLeftButtonAppearance(Appearance) is the preferred method of showing no text.
    
    Parameters:
    
    text - the text label to display
    
    behaviourClass - the behaviour class to set the label for, null to use the class of the current behaviour
  - getRightButtonText
```
public final java.lang.CharSequence getRightButtonText(java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)
```
    Returns the text to display in the right button for a particular behaviour class.
    
    Parameters:
    
    behaviourClass - the behaviour class to query the text against, null to use the class of the current behaviour
    
    Returns:
    
    the text for behaviourClass, null if there is none
  - setRightButtonIcon
```
public final void setRightButtonIcon(android.graphics.drawable.Drawable icon,
                                     java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)
```
    Sets the icon to display in the right button for a single behaviour class. The current appearance of the button determines whether or not the icon will actually be displayed, and where it will be located. Although null is accepted, changing the button appearance using setRightButtonAppearance(IntroButton.Appearance) is the preferred method of showing no icon.
    
    Parameters:
    
    icon - the icon to display
    
    behaviourClass - the behaviour class to set the icon for, null to use the class of the current appearance
  - getRightButtonIcon
```
public final android.graphics.drawable.Drawable getRightButtonIcon(java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)
```
    Returns the icon to display in the right button for a particular behaviour.
    
    Parameters:
    
    behaviourClass - the behaviour class to query the icon against, null to use the class of the current behaviour
    
    Returns:
    
    the icon for behaviourClass, null if there is none
  - setRightButtonTextColor
```
public final void setRightButtonTextColor(int color)
```
    Sets the text color of the right button. The color is common to all behaviours.
    
    Parameters:
    
    color - the color to use, as an ARGB hex code
  - getRightButtonTextColor
```
public final int getRightButtonTextColor()
```
    Returns the color of the text in the right button. The color is common to all behaviours.
    
    Returns:
    
    the text color, as an ARGB hex code
  - setRightButtonTextSize
```
public final void setRightButtonTextSize(float sizeSp)
```
    Sets the size of the text in the right button. The size is common to all behaviours.
    
    Parameters:
    
    sizeSp - the size to use, measured in scaled-pixels
  - getRightButtonTextSize
```
public final float getRightButtonTextSize()
```
    Returns the size of the text in the right button. The size is common to all behaviours.
    
    Returns:
    
    the text size, measured in pixels
  - setRightButtonTypeface
```
public final void setRightButtonTypeface(android.graphics.Typeface tf,
                                         int style)
```
    Sets the typeface and style in which the text of the right button should be displayed. Turns on the fake bold and italic bits in the Paint if the Typeface that you provided does not have all the bits in the style that you specified.
    
    Parameters:
    
    tf - the typeface to use
    
    style - style for the typeface
  - setRightButtonTypeface
```
public final void setRightButtonTypeface(android.graphics.Typeface tf)
```
    Sets the typeface and style in which the text of the right button should be displayed. Turns on the fake bold and italic bits in the Paint if the Typeface that you provided does not have all the bits in the style that you specified.
    
    Parameters:
    
    tf - the typeface to use
  - setRightButtonOnClickListener
```
public final void setRightButtonOnClickListener(android.view.View.OnClickListener l)
```
    Register a callback to be invoked when the right button is clicked. If the button is not clickable, it becomes clickable. Registering for on-click events does not prevent the right button from performing its predefined behaviour.
    
    Parameters:
    
    l - the callback that will run, null to clear the existing listener
  - disableRightButton
```
public final void disableRightButton(boolean disabled)
```
    Hides and disables the right button.
    
    Parameters:
    
    disabled - whether or not the button should be hidden/disabled
  - rightButtonIsDisabled
```
public final boolean rightButtonIsDisabled()
```
    Returns whether or not the right button is currently disabled and hidden.
    
    Returns:
    
    true if disabled and hidden, false otherwise
  - setFinalButtonBehaviour
```
public final void setFinalButtonBehaviour(IntroButton.Behaviour behaviour)
```
    Sets the behaviour of the final button. This is distinct from the on-click behaviour, which can be set using #setLeftButtonOnClickListener(OnClickListener). Predefined behaviours are provided in the IntroButton class, however custom behaviours are accepted. To use a custom behaviour, implement IntroButton.Behaviour and pass an instance of the implementation to this method. Alternatively, subclassing IntroButton.BehaviourAdapter simplifies the implementation and eliminates boilerplate code.
    
    Parameters:
    
    behaviour - the behaviour to use when left button is pressed, not null
  - getFinalButtonBehaviour
```
public final IntroButton.Behaviour getFinalButtonBehaviour()
```
    Returns:
    
    the current behaviour of the final button
  - setFinalButtonAppearance
```
public final void setFinalButtonAppearance(IntroButton.Appearance appearance)
```
    Sets the appearance of the final button.
    
    Parameters:
    
    appearance - the predefined appearance to use, not null
  - getFinalButtonAppearance
```
public final IntroButton.Appearance getFinalButtonAppearance()
```
    Returns:
    
    the current Appearance of the final button
  - setFinalButtonText
```
public final void setFinalButtonText(java.lang.CharSequence text,
                                     java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)
```
    Sets the text to display in the final button for a single behaviour class. The current appearance of the button determines whether or not the text will actually be displayed. Although null is accepted, changing the button appearance using #setLeftButtonAppearance(Appearance) is the preferred method of showing no text.
    
    Parameters:
    
    text - the text label to display
    
    behaviourClass - the behaviour class to set the label for, null to use the class of the current behaviour
  - getFinalButtonText
```
public final java.lang.CharSequence getFinalButtonText(java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)
```
    Returns the text to display in the final button for a particular behaviour class.
    
    Parameters:
    
    behaviourClass - the behaviour class to query the text against, null to use the class of the current behaviour
    
    Returns:
    
    the text for behaviourClass, null if there is none
  - setFinalButtonIcon
```
public final void setFinalButtonIcon(android.graphics.drawable.Drawable icon,
                                     java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)
```
    Sets the icon to display in the final button for a single behaviour class. The current appearance of the button determines whether or not the icon will actually be displayed, and where it will be located. Although null is accepted, changing the button appearance using setFinalButtonAppearance(IntroButton.Appearance) is the preferred method of showing no icon.
    
    Parameters:
    
    icon - the icon to display
    
    behaviourClass - the behaviour class to set the icon for, null to use the class of the current appearance
  - getFinalButtonIcon
```
public final android.graphics.drawable.Drawable getFinalButtonIcon(java.lang.Class<? extends IntroButton.Behaviour> behaviourClass)
```
    Returns the icon to display in the final button for a particular behaviour.
    
    Parameters:
    
    behaviourClass - the behaviour class to query the icon against, null to use the class of the current behaviour
    
    Returns:
    
    the icon for behaviourClass, null if there is none
  - setFinalButtonTextColor
```
public final void setFinalButtonTextColor(int color)
```
    Sets the color of the text in the final button. The color is common to all behaviours.
    
    Parameters:
    
    color - the color to use, as an ARGB hex code
  - getFinalButtonTextColor
```
public final int getFinalButtonTextColor()
```
    Returns the color of the text in the final button. The color is common to all behaviours.
    
    Returns:
    
    the text color, as an ARGB hex code
  - setFinalButtonTextSize
```
public final void setFinalButtonTextSize(float sizeSp)
```
    Sets the size of the text in the final button. The size is common to all behaviours.
    
    Parameters:
    
    sizeSp - the size to use, measured in scaled-pixels
  - getFinalButtonTextSize
```
public final float getFinalButtonTextSize()
```
    Returns the size of the text in the final button. The size is common to all behaviours.
    
    Returns:
    
    the text size, measured in pixels
  - setFinalButtonTypeface
```
public final void setFinalButtonTypeface(android.graphics.Typeface tf,
                                         int style)
```
    Sets the typeface and style in which the text of the final button should be displayed. Turns on the fake bold and italic bits in the Paint if the Typeface that you provided does not have all the bits in the style that you specified.
    
    Parameters:
    
    tf - the typeface to use
    
    style - style for the typeface
  - setFinalButtonTypeface
```
public final void setFinalButtonTypeface(android.graphics.Typeface tf)
```
    Sets the typeface and style in which the text of the final button should be displayed. Turns on the fake bold and italic bits in the Paint if the Typeface that you provided does not have all the bits in the style that you specified.
    
    Parameters:
    
    tf - the typeface to use
  - setFinalButtonOnClickListener
```
public final void setFinalButtonOnClickListener(android.view.View.OnClickListener l)
```
    Register a callback to be invoked when the final button is clicked. If the button is not clickable, it becomes clickable. Registering for on-click events does not prevent the final button from performing its predefined behaviour.
    
    Parameters:
    
    l - the callback that will run, null to clear the existing listener
  - disableFinalButton
```
public final void disableFinalButton(boolean disabled)
```
    Hides and disables the final button.
    
    Parameters:
    
    disabled - whether or not the button should be hidden/disabled
  - finalButtonIsDisabled
```
public final boolean finalButtonIsDisabled()
```
    Returns whether or not the left button is currently disabled and hidden.
    
    Returns:
    
    true if disabled and hidden, false otherwise
  - onPageScrolled
```
public void onPageScrolled(int position,
                           float positionOffset,
                           int positionOffsetPixels)
```
  - onPageSelected
```
public void onPageSelected(int position)
```
  - onPageScrollStateChanged
```
public void onPageScrollStateChanged(int state)
```
  - onItemAdded
```
public void onItemAdded(ArrayListWithCallbacks list,
                        java.lang.Object itemAdded,
                        int index)
```
  - onItemRemoved
```
public void onItemRemoved(ArrayListWithCallbacks list,
                          java.lang.Object itemRemoved,
                          int index)
```
  - onListCleared
```
public void onListCleared(ArrayListWithCallbacks list)
```

Class IntroActivity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IntroActivity

Method Detail

onCreate

onSaveInstanceState

onBackPressed

generatePages

generateFinalButtonBehaviour

hideStatusBar

showStatusBar

getRootView

setPageTransformer

getPages

getPage

getCurrentPage

getFirstPage

getLastPage

getIndexOfPage

getIndexOfCurrentPage

goToPage

goToLastPage

goToFirstPage

goToNextPage

goToPreviousPage

numberOfPages

setPagingLockMode

getPagingLockMode

setProgressIndicator

getProgressIndicator

enableProgressIndicatorAnimations

progressIndicatorAnimationsAreEnabled

setLeftButtonBehaviour

getLeftButtonBehaviour

setLeftButtonAppearance

getLeftButtonAppearance

setLeftButtonText

getLeftButtonText

setLeftButtonIcon

getLeftButtonIcon

setLeftButtonTextColor

getLeftButtonTextColor

setLeftButtonTextSize

getLeftButtonTextSize

setLeftButtonTypeface

setLeftButtonTypeface

setLeftButtonOnClickListener

disableLeftButton

leftButtonIsDisabled

hideLeftButtonOnLastPage

leftButtonIsHiddenOnLastPage

setRightButtonBehaviour

getRightButtonBehaviour

setRightButtonAppearance

getRightButtonAppearance

setRightButtonText

getRightButtonText

setRightButtonIcon

getRightButtonIcon

setRightButtonTextColor

getRightButtonTextColor

setRightButtonTextSize

getRightButtonTextSize

setRightButtonTypeface

setRightButtonTypeface

setRightButtonOnClickListener

disableRightButton

rightButtonIsDisabled

setFinalButtonBehaviour

getFinalButtonBehaviour

setFinalButtonAppearance

getFinalButtonAppearance

setFinalButtonText

getFinalButtonText

setFinalButtonIcon

getFinalButtonIcon

setFinalButtonTextColor