de.mrapp.android.preference.activity

Interface WizardListener

public interface WizardListener

Defines the interface a class, which should be notified when the user navigates within a PreferenceActivity, which is used as wizard, by using its next-, back- and finish-button. The return values of the interface's methods allow to take influence on the navigation, e.g. if the currently shown preferences should be validated.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
boolean	onFinish(NavigationPreference navigationPreference, Fragment fragment, android.os.Bundle bundle) The method, which is invoked, when the user wants to finish the last step of the wizard.
android.os.Bundle	onNextStep(NavigationPreference navigationPreference, Fragment fragment, android.os.Bundle bundle) The method, which is invoked, when the user wants to navigate to the next step of the wizard.
android.os.Bundle	onPreviousStep(NavigationPreference navigationPreference, Fragment fragment, android.os.Bundle bundle) The method, which is invoked, when the user wants to navigate to the previous step of the wizard.
boolean	onSkip(NavigationPreference navigationPreference, Fragment fragment, android.os.Bundle bundle) The method, which is invoked, when the user wants to skip the wizard.

Method Detail

onNextStep

android.os.Bundle onNextStep(NavigationPreference navigationPreference,
                             Fragment fragment,
                             android.os.Bundle bundle)

The method, which is invoked, when the user wants to navigate to the next step of the wizard.

Parameters:

navigationPreference - The currently selected navigation preference as an instance of the class NavigationPreference. The navigation preference may not be null

fragment - The currently shown preference fragment as an instance of the class Fragment. The fragment may not be null

bundle - A bundle, which contains the parameters, which have been passed to the currently shown preference fragment, as an instance of the class Bundle or null, if no parameters have been passed to the fragment

Returns:

The bundle, which should be passed to the next fragment, as an instance of the class Bundle or null, if navigating to the next step of the wizard should not be allowed

onPreviousStep

android.os.Bundle onPreviousStep(NavigationPreference navigationPreference,
                                 Fragment fragment,
                                 android.os.Bundle bundle)

The method, which is invoked, when the user wants to navigate to the previous step of the wizard.

Parameters:

navigationPreference - The currently selected navigation preference as an instance of the class NavigationPreference. The navigation preference may not be null

fragment - The currently shown preference fragment as an instance of the class Fragment. The fragment may not be null

bundle - A bundle, which contains the parameters, which have been passed to the currently shown preference fragment, as an instance of the class Bundle or null, if no parameters have been passed to the fragment

Returns:

The bundle, which should be passed to the next fragment, as an instance of the class Bundle or null, if navigating to the previous step of the wizard should not be allowed

onFinish

boolean onFinish(NavigationPreference navigationPreference,
                 Fragment fragment,
                 android.os.Bundle bundle)

The method, which is invoked, when the user wants to finish the last step of the wizard.

Parameters:

navigationPreference - The currently selected navigation preference as an instance of the class NavigationPreference. The navigation preference may not be null

fragment - The currently shown preference fragment as an instance of the class Fragment. The fragment may not be null

bundle - A bundle, which contains the parameters, which have been passed to the currently shown preference fragment, as an instance of the class Bundle or null, if no parameters have been passed to the fragment

Returns:

True, if finishing the wizard should be allowed, false otherwise

onSkip

boolean onSkip(NavigationPreference navigationPreference,
               Fragment fragment,
               android.os.Bundle bundle)

The method, which is invoked, when the user wants to skip the wizard.

Parameters:

navigationPreference - The currently selected navigation preference as an instance of the class NavigationPreference. The navigation preference may not be null

fragment - The currently shown preference fragment as an instance of the class Fragment. The fragment may not be null

bundle - A bundle, which contains the parameters, which have been passed to the currently shown preference fragment, as an instance of the class Bundle or null, if no parameters have been passed to the fragment

Returns:

True, if skipping the wizard should be allowed, false otherwise