Package net.gini.android.capture.help

Types

FileImportActivity
Link copied to clipboard
public class FileImportActivity extends AppCompatActivity
Screen API and Component API On the File Import Screen users can get information about how import files from other apps via "open with".
HelpActivity
Link copied to clipboard
public final class HelpActivity extends AppCompatActivity

Screen API and Component API

On the Help Screen users can get information about how to best use the Gini Capture SDK.

This Activity can be used for both Screen and Component APIs.

Customizing the Help Screen

Customizing the look of the Help Screen is done via overriding of app resources.

The following items are customizable:

  • Background color: via the color resource named {@code gc_help_activity_background}
  • Help list item background color: via the color resource name {@code gc_help_item_background}
  • Help list item text style: via overriding the style named {@code GiniCaptureTheme.Help.Item.TextStyle}
  • Help list item labels: via overriding the string resources found in the {@link DefaultHelpItem} enum

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

Customizing the Action Bar is done via overriding of app resources and each one - except the title string resource - is global to all Activities ({@link CameraActivity}, {@link NoResultsActivity}, {@link HelpActivity}, {@link ReviewActivity}, {@link 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 name {@code gc_title_help}
  • 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}

HelpItem
Link copied to clipboard
public class HelpItem
This sealed class declares the items which can be shown in the Help Screen.
PhotoTipsActivity
Link copied to clipboard
public class PhotoTipsActivity extends AppCompatActivity
Screen API and Component API On the Photo Tips Screen users can get information about how to take better pictures.
SupportedFormatsActivity
Link copied to clipboard
public class SupportedFormatsActivity extends AppCompatActivity
Screen API and Component API The Supported Formats Screen shows information about the document formats supported by the Gini Capture SDK.