Package net.gini.android.capture.onboarding

Internal use only.

Internal use only.

Internal use only.

Screen API

When you use the Screen API, the {@code OnboardingActivity} displays important advice for correctly photographing a document.

The {@code OnboardingActivity} is started by the CameraActivity when the latter is launched for the first time. You may disable this behavior - we highly recommend keeping it - by passing {@code false} to setShouldShowOnboardingAtFirstRun when creating a GiniCapture instance.

You can change the number of displayed pages and their content (image and short text) by setting an {@code ArrayList} containing OnboardingPage objects when building a instance with .

Customizing the look of the Onboarding Screen is done via overriding of app resources or by providing your own pages with your own strings and drawable resources.

The following items are customizable:

• Next button icon: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named {@code * gc_onboarding_fab_next.png}
• Next button color: via the color resources named {@code gc_onboarding_fab} and {@code * gc_onboarding_fab_pressed}
• Page indicators: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named {@code * gc_onboarding_indicator_active.png} and {@code gc_onboarding_indicator_inactive.png}
• Onboarding message color: via the color resource named {@code gc_onboarding_message}
• Onboarding message font: via overriding the style named {@code * GiniCaptureTheme.Onboarding.Message.TextStyle} and setting an item named {@code gcCustomFont} with the path to the font file in your {@code assets} folder
• Onboarding message text style: via overriding the style named {@code * GiniCaptureTheme.Onboarding.Message.TextStyle} and setting an item named {@code android:textStyle} to {@code normal} , {@code bold} or {@code italic}
• Onboarding message text size: via overriding the style named {@code * GiniCaptureTheme.Onboarding.Message.TextStyle} and setting an item named {@code android:textSize} to the desired {@code sp} size
• Tablet Onboarding Pages:
  • First page image via images for sw600dp-mdpi, sw600dp-hdpi, sw600dp-xhdpi, sw600dp-xxhdpi, sw600dp-xxxhdpi named {@code gc_onboarding_lighting.png}
  • First page text: via the string resource named {@code gc_onboarding_ligthing}
  • Second page image via images for sw600dp-mdpi, sw600dp-hdpi, sw600dp-xhdpi, sw600dp-xxhdpi, sw600dp-xxxhdpi named {@code gc_onboarding_flat.png}
  • Second page text: via the string resource named {@code gc_onboarding_flat}
  • Third page image: via images for sw600dp-mdpi, sw600dp-hdpi, sw600dp-xhdpi, sw600dp-xxhdpi, sw600dp-xxxhdpi named {@code gc_onboarding_parallel.png}
  • Third page text: via the string resource named {@code gc_onboarding_parallel}
  • Fourth page image: via images for sw600dp-mdpi, sw600dp-hdpi, sw600dp-xhdpi, sw600dp-xxhdpi, sw600dp-xxxhdpi named {@code gc_onboarding_align.png}
  • Fourth page text: via the string resource named {@code gc_onboarding_align}
• Phone Onboarding Pages:
  • First page image: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named {@code * gc_onboarding_flat.png}
  • First page text: via the string resource named {@code gc_onboarding_flat}
  • Second page image: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named {@code * gc_onboarding_parallel.png}
  • Second page text: via the string resource named {@code gc_onboarding_parallel}
  • Third page image: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named {@code * gc_onboarding_align.png}
  • Third page text: via the string resource named {@code gc_onboarding_align}
• Background transparency: via the string resource named {@code * gc_onboarding_page_fragment_background_alpha} which must contain a real number between [0,1].
• Background color: via the color resource named {@code gc_background} . Note: this color resource is global to all Activities ( CameraActivity , , ReviewActivity , AnalysisActivity )

Important: All overriden styles must have their respective {@code Root.} prefixed style as their parent. Ex.: the parent of {@code GiniCaptureTheme.Onboarding.Message.TextStyle} must be {@code Root.GiniCaptureTheme.Onboarding.Message.TextStyle} .

Customizing the Action Bar is also done via overriding of app resources and each one - except the title string resource - is global to all Activities ( CameraActivity , , ReviewActivity , AnalysisActivity ).

The following items are customizable:

• Background color: via the color resource named {@code gc_action_bar} (highly recommended for Android 5+: customize the status bar color via {@code gc_status_bar} )
• Title: via the string resource named {@code gc_title_onboarding}
• Title color: via the color resource named {@code gc_action_bar_title}
• Back button: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named {@code gc_action_bar_back}

Component API

When you use the Component API with the Android Support Library, the {@code * OnboardingFragmentCompat} displays important advice for correctly photographing a document.

Note: Your Activity hosting this Fragment must extend the and use an AppCompat Theme.

Include the {@code OnboardingFragmentCompat} into your layout either directly with {@code * } in your Activity's layout or using the androidx.fragment.app.FragmentManager .

The default way of showing the Onboarding Screen is as an overlay above the camera preview with a semi-transparent background.

By default an empty last page is added to enable the revealing of the camera preview before the Onboarding Screen is dismissed.

If you would like to display a different number of pages, you can use the or factory method and provide a list of OnboardingPage objects.

If you would like to disable the appending of the empty last page, you can use the or the factory method.

An OnboardingFragmentListener instance must be available until the {@code * OnboardingFragmentCompat} is attached to an activity. Failing to do so will throw an exception. The listener instance can be provided either implicitly by making the hosting Activity implement the OnboardingFragmentListener interface or explicitly by setting the listener using setListener .

Your Activity is automatically set as the listener in onCreate .

See the OnboardingActivity for details.

Internal use only.

Methods which Onboarding Fragment must implement.

Interface used by OnboardingFragmentCompat to dispatch events to the hosting Activity.

The {@code OnboardingPage} is used by the Onboarding Fragment 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.

When using the Screen API set an java.util.ArrayList containing {@code OnboardingPage} objects as the when starting the CameraActivity .

When using the Componenent API provide an java.util.ArrayList containing {@code OnboardingPage} objects as the argument for the Onboarding Fragment factory method .

Created by Alpar Szotyori on 20.05.2019. Copyright (c) 2019 Gini GmbH.

Internal use only.

Created by Alpar Szotyori on 20.05.2019. Copyright (c) 2019 Gini GmbH.

Created by Alpar Szotyori on 20.05.2019. Copyright (c) 2019 Gini GmbH.

Created by Alpar Szotyori on 20.05.2019. Copyright (c) 2019 Gini GmbH.