net.gini.android.vision.help

Class HelpActivity

java.lang.Object

AppCompatActivity

net.gini.android.vision.help.HelpActivity

public class HelpActivity
extends AppCompatActivity

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:

• HelpActivity.EXTRA_IN_GINI_VISION_FEATURE_CONFIGURATION - Must contain a GiniVisionFeatureConfiguration instance

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 gv_help_activity_background
• Help list item background color: via the color resource name gv_help_item_background
• Help list item text style: via overriding the style named 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 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 done via overriding of app resources and each one - except the title string resource - is global to all Activities (CameraActivity, NoResultsActivity, HelpActivity, 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 name gv_title_help
• 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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTRA_IN_GINI_VISION_FEATURE_CONFIGURATION Deprecated. Configuration should be applied by creating a GiniVision instance using GiniVision.newInstance() and the returned GiniVision.Builder.

Constructor Summary

Constructors

Constructor and Description
HelpActivity()

Method Summary

Modifier and Type	Method and Description
boolean	onOptionsItemSelected(MenuItem item)

Methods inherited from class java.lang.Object

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

Field Detail

EXTRA_IN_GINI_VISION_FEATURE_CONFIGURATION

public static final java.lang.String EXTRA_IN_GINI_VISION_FEATURE_CONFIGURATION

Deprecated. Configuration should be applied by creating a GiniVision instance using GiniVision.newInstance() and the returned GiniVision.Builder.

Optional extra which must contain a GiniVisionFeatureConfiguration instance.

See Also:

Constant Field Values

Constructor Detail

HelpActivity

public HelpActivity()

Method Detail

onOptionsItemSelected

public boolean onOptionsItemSelected(MenuItem item)