net.gini.android.vision.onboarding

Class OnboardingActivity

java.lang.Object

AppCompatActivity

net.gini.android.vision.onboarding.OnboardingActivity

All Implemented Interfaces:

OnboardingFragmentListener

public class OnboardingActivity
extends AppCompatActivity
implements OnboardingFragmentListener

Screen API

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

The 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 false to GiniVision.Builder#setShouldShowOnboardingAtFirstRun(boolean) when creating a GiniVision instance. If you don't use GiniVision yet you can also use the extra CameraActivity.EXTRA_IN_SHOW_ONBOARDING_AT_FIRST_RUN with false when starting the CameraActivity.

You can change the number of displayed pages and their content (image and short text) by setting an ArrayList containing OnboardingPage objects when building a GiniVision instance with GiniVision.Builder#setCustomOnboardingPages(ArrayList). If you don't use GiniVision yet you can also provide the list using the extra CameraActivity.EXTRA_IN_ONBOARDING_PAGES for the Screen API and OnboardingFragmentCompat.createInstance(ArrayList) or OnboardingFragmentStandard.createInstance(ArrayList) for the Component API.

Customizing the Onboarding Screen

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 gv_onboarding_fab_next.png
• Next button color: via the color resources named gv_onboarding_fab and gv_onboarding_fab_pressed
• Page indicators: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_onboarding_indicator_active.png and gv_onboarding_indicator_inactive.png
• Onboarding message color: via the color resource named gv_onboarding_message
• Onboarding message font: via overriding the style named GiniVisionTheme.Onboarding.Message.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
• Onboarding message text style: via overriding the style named GiniVisionTheme.Onboarding.Message.TextStyle and setting an item named android:textStyle to normal, bold or italic
• Onboarding message text size: via overriding the style named GiniVisionTheme.Onboarding.Message.TextStyle and setting an item named android:textSize to the desired sp size
• Tablet Onboarding Pages:
  • First page image via images for sw600dp-mdpi, sw600dp-hdpi, sw600dp-xhdpi, sw600dp-xxhdpi, sw600dp-xxxhdpi named gv_onboarding_lighting.png
  • First page text: via the string resource named gv_onboarding_ligthing
  • Second page image via images for sw600dp-mdpi, sw600dp-hdpi, sw600dp-xhdpi, sw600dp-xxhdpi, sw600dp-xxxhdpi named gv_onboarding_flat.png
  • Second page text: via the string resource named gv_onboarding_flat
  • Third page image: via images for sw600dp-mdpi, sw600dp-hdpi, sw600dp-xhdpi, sw600dp-xxhdpi, sw600dp-xxxhdpi named gv_onboarding_parallel.png
  • Third page text: via the string resource named gv_onboarding_parallel
  • Fourth page image: via images for sw600dp-mdpi, sw600dp-hdpi, sw600dp-xhdpi, sw600dp-xxhdpi, sw600dp-xxxhdpi named gv_onboarding_align.png
  • Fourth page text: via the string resource named gv_onboarding_align
• Phone Onboarding Pages:
  • First page image: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_onboarding_flat.png
  • First page text: via the string resource named gv_onboarding_flat
  • Second page image: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_onboarding_parallel.png
  • Second page text: via the string resource named gv_onboarding_parallel
  • Third page image: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_onboarding_align.png
  • Third page text: via the string resource named gv_onboarding_align
• Background transparency: via the string resource named gv_onboarding_page_fragment_background_alpha which must contain a real number between [0,1].
• Background color: via the color resource named gv_background. Note: this color resource is global to all Activities (CameraActivity, OnboardingActivity, ReviewActivity, AnalysisActivity)

Important: All overriden styles must have their respective Root. prefixed style as their parent. Ex.: the parent of GiniVisionTheme.Onboarding.Message.TextStyle must be Root.GiniVisionTheme.Onboarding.Message.TextStyle.

Customizing the Action Bar

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, OnboardingActivity, ReviewActivity, AnalysisActivity).

The following items are customizable:

• Background color: via the color resource named gv_action_bar (highly recommended for Android 5+: customize the status bar color via gv_status_bar)
• Title: via the string resource named gv_title_onboarding
• Title color: via the color resource named gv_action_bar_title
• Back button: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_action_bar_back

Constructor Summary

Constructors

Constructor and Description
OnboardingActivity()

Method Summary

Modifier and Type	Method and Description
void	onCloseOnboarding() Called when the user has left the last page - either by swiping or tapping on the Next button - and you should close the Onboarding Fragment.
void	onError(GiniVisionError giniVisionError) Called when an error occurred.
boolean	onOptionsItemSelected(MenuItem item)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OnboardingActivity

public OnboardingActivity()

Method Detail

onOptionsItemSelected

public boolean onOptionsItemSelected(MenuItem item)

onCloseOnboarding

public void onCloseOnboarding()

Description copied from interface: OnboardingFragmentListener

Called when the user has left the last page - either by swiping or tapping on the Next button - and you should close the Onboarding Fragment.

Specified by:

onCloseOnboarding in interface OnboardingFragmentListener

onError

public void onError(GiniVisionError giniVisionError)

Description copied from interface: OnboardingFragmentListener

Called when an error occurred.

Specified by:

onError in interface OnboardingFragmentListener

Parameters:

giniVisionError - details about what went wrong