Package net.gini.android.vision.help

Screen API and Component API

On the File Import Screen users can get information about how import files from other apps via "open with".

This Activity is launched by the HelpActivity for both Screen and Component APIs.

Important: The File Import Screen is only shown only if file import was enabled with the GiniVisionFeatureConfiguration .

The contents of this screen need to be customized to insert your App's name or label for the "open with" functionality into the texts and illustrations.

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

The following items are customizable:

• Background color: via the color resource named {@code gv_file_import_activity_background} .
• Header text: via overriding the string resource named {@code gv_file_import_header}
• Header text style: via overriding the style named {@code GiniVisionTheme.Help.FileImport.Header.TextStyle}
• Separator line color: via the color resource named {@code gv_file_import_separator}
• Section numbers' background circle color: via the color resource named {@code gv_file_import_section_number_background}
• Section numbers' text color: via the color resource named {@code gv_file_import_section_number}
• Section title text style: via overriding the style named {@code GiniVisionTheme.Help.FileImport.Section.Title.TextStyle}
• Section body text style: via overriding the style named {@code GiniVisionTheme.Help.FileImport.Section.Body.TextStyle}
• Section 1 title: via overriding the string resource named {@code gv_file_import_section_1_title}
• Section 1 body: via overriding the string resource named {@code gv_file_import_section_1_body}
• Section 1 illustration image: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named {@code gv_file_import_section_1_illustration.png} . For creating your custom illustration you may use this template from the Gini Vision Library UI Assets repository.
• Section 2 title: via overriding the string resource named {@code gv_file_import_section_2_title}
• Section 2 body: via overriding the string resource named {@code gv_file_import_section_2_body}
• Section 2 illustration image: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named {@code gv_file_import_section_2_illustration.png} . For creating your custom illustration you may use this template from the Gini Vision Library UI Assets repository.
• Section 3 title: via overriding the string resource named {@code gv_file_import_section_3_title}
• Section 3 body: via overriding the string resource named {@code gv_file_import_section_3_body}
• Section 3 illustration image: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named {@code gv_file_import_section_3_illustration.png}

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

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

The following items are customizable:

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

Screen API and Component API

On the Help Screen users can get information about how to best use the Gini Vision Library.

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

For the Component API you need to pass in the following extra:

• EXTRA_IN_GINI_VISION_FEATURE_CONFIGURATION - Must contain a GiniVisionFeatureConfiguration instance

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 gv_help_activity_background}
• Help list item background color: via the color resource name {@code gv_help_item_background}
• Help list item text style: via overriding the style named {@code * GiniVisionTheme.Help.Item.TextStyle}
• Help list item labels: via overriding the string resources found in the HelpItem enum

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

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

The following items are customizable:

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

This enum declares the items which are shown in the Help Screen.

Internal use only.

Screen API and Component API

On the Photo Tips Screen users can get information about how to take better pictures.

This Activity is launched by the HelpActivity for both Screen and Component APIs.

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

The following items are customizable:

• Background color: via the color resource named {@code gv_photo_tips_activity_background} .
• Header text style: via overriding the style named {@code GiniVisionTheme.Help.PhotoTips.Header.TextStyle}
• Tip text style: via overriding the style named {@code GiniVisionTheme.Help.PhotoTips.Tip.TextStyle}
• Tip image - Good lighting: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named {@code gv_photo_tip_lighting.png}
• Tip image - Document should be flat: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named {@code gv_photo_tip_flat.png}
• Tip image - Device should be parallel to document: via images for mdpi, hdpi, xhdpi,xxhdpi, xxxhdpi named {@code gv_photo_tip_parallel.png}
• Tip image - Document should be aligned with corner guides: via images for mdpi, hdpi, xhdpi,xxhdpi, xxxhdpi named {@code gv_photo_tip_align.png}
• Button color: via the color resource named {@code gv_photo_tips_button}
• Button text color: via the color resource named {@code gv_photo_tips_button_text}

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

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

The following items are customizable:

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

Screen API and Component API

The Supported Formats Screen shows information about the document formats supported by the Gini Vision Library.

This Activity is launched by the HelpActivity for both Screen and Component APIs.

The contents of this screen are modified according to the features you configured with the GiniVisionFeatureConfiguration .

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

The following items are customizable:

• Background color: via the color resource named {@code gv_supported_formats_activity_background} .
• Header text style: via overriding the style named {@code GiniVisionTheme.Help.SupportedFormats.Item.Header.TextStyle}
• Format info text style: via overriding the style named {@code GiniVisionTheme.Help.SupportedFormats.Item.TextStyle}
• Format info list item background color: via overriding the style named {@code gv_supported_formats_item_background}
• Supported format background circle color: via the color resource named {@code gv_supported_formats_item_supported_icon_background}
• Supported format foreground tick color: via the color resource named {@code gv_supported_formats_item_supported_icon_foreground}
• Unsupported format background circle color: via the color resource named {@code gv_supported_formats_item_unsupported_icon_background}
• Unsupported format foreground cross color: via the color resource named {@code gv_supported_formats_item_unsupported_icon_foreground}

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

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

The following items are customizable:

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

Internal use only.