-
- All Implemented Interfaces:
-
android.os.Parcelable
public class OnboardingPage implements Parcelable
The
{@code OnboardingPage}is used by the Onboarding Screen to display an image and a short text.Use this class to show a different number of pages in the Onboarding Screen. Customizing the default onboarding pages can be done via overriding of app resources.
-
-
Field Summary
Fields Modifier and Type Field Description private final inttitleResIdprivate final intmessageResIdprivate OnboardingIllustrationAdapterillustrationAdapterpublic final static Parcelable.Creator<OnboardingPage>CREATOR
-
Constructor Summary
Constructors Constructor Description OnboardingPage(int titleResId, int messageResId, OnboardingIllustrationAdapter illustrationAdapter)Create a new onboarding page with the desired string resources and icon adapter.
-
Method Summary
Modifier and Type Method Description intgetTitleResId()intgetMessageResId()OnboardingIllustrationAdaptergetIllustrationAdapter()voidsetIllustrationAdapter(OnboardingIllustrationAdapter illustrationAdapter)intdescribeContents()Internal use only. voidwriteToParcel(Parcel dest, int flags)Internal use only. -
-
Constructor Detail
-
OnboardingPage
OnboardingPage(int titleResId, int messageResId, OnboardingIllustrationAdapter illustrationAdapter)
Create a new onboarding page with the desired string resources and icon adapter.- Parameters:
titleResId- a string resource id which will be shown in the onboarding pagemessageResId- a string resource id which will be shown in the onboarding pageillustrationAdapter- an icon adapter for the onboarding page
-
-
Method Detail
-
getTitleResId
@StringRes() int getTitleResId()
-
getMessageResId
@StringRes() int getMessageResId()
-
getIllustrationAdapter
@Nullable() OnboardingIllustrationAdapter getIllustrationAdapter()
-
setIllustrationAdapter
void setIllustrationAdapter(OnboardingIllustrationAdapter illustrationAdapter)
- Parameters:
illustrationAdapter- an icon adapter for the onboarding page
-
describeContents
int describeContents()
Internal use only.
-
writeToParcel
void writeToParcel(Parcel dest, int flags)
Internal use only.
-
-
-
-