Package net.gini.android.vision.onboarding

Contains the Activity and Fragments used for the Onboarding Screen.

Screen API

The net.gini.android.vision.onboarding.OnboardingActivity is launched directly by the net.gini.android.vision.camera.CameraActivity. It can be configured by overriding Gini Vision Library app resources and/or by supplying the net.gini.android.vision.camera.CameraActivity with an java.util.ArrayList of net.gini.android.vision.onboarding.OnboardingPage objects in the net.gini.android.vision.camera.CameraActivity.EXTRA_IN_ONBOARDING_PAGES extra.

Component API

To use the Component API you have to include the net.gini.android.vision.onboarding.OnboardingFragmentStandard or the net.gini.android.vision.onboarding.OnboardingFragmentCompat in an Activity in your app (a dedicated Activity is recommended). To receive events from the Fragments your Activity must implement the net.gini.android.vision.onboarding.OnboardingFragmentListener interface.

The Onboarding Screen was designed as a semi-transparent overlay for the camera preview. Your Activity should be configured to be transparent and the Camera Fragment should not stop the camera when the onboarding is shown.

Types

ConditionalPages

public enum ConditionalPages

Internal use only.

DefaultPagesPhone

public enum DefaultPagesPhone

Internal use only.

DefaultPagesTablet

public enum DefaultPagesTablet

Internal use only.

OnboardingActivity

public class OnboardingActivity extends AppCompatActivity implements OnboardingFragmentListener

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

OnboardingFragmentCompat

public class OnboardingFragmentCompat extends Fragment implements OnboardingFragmentImplCallback, OnboardingFragmentInterface

Component API When you use the Component API with the Android Support Library, the


OnboardingFragmentCompat

displays important advice for correctly photographing a document.

OnboardingFragmentImplCallback

public interface OnboardingFragmentImplCallback implements FragmentImplCallback

Internal use only.

OnboardingFragmentInterface

public interface OnboardingFragmentInterface

Methods which both Onboarding Fragments must implement.

OnboardingFragmentListener

public interface OnboardingFragmentListener

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

OnboardingFragmentStandard

public class OnboardingFragmentStandard extends Fragment implements OnboardingFragmentImplCallback, OnboardingFragmentInterface

Component API When you use the Component API without the Android Support Library, the OnboardingFragmentStandard displays important advice for correctly photographing a document.

OnboardingPage

public class OnboardingPage implements Parcelable

The OnboardingPage is used by the Onboarding Fragment to display an image and a short text.

OnboardingPageFragmentCompat

public class OnboardingPageFragmentCompat extends Fragment implements FragmentImplCallback

Internal use only.

OnboardingPageFragmentStandard

public class OnboardingPageFragmentStandard extends Fragment implements FragmentImplCallback

Internal use only.