Imagine

java.lang.Object
- Fragment
- - com.example.staysafe.Imagine

```
public class Imagine
extends Fragment
```
The Imagine Fragment is responsible for displaying the Imagine screen to the user. The imagine screen consists of one of the options the user selected on the previous screens and three done buttons. The user is prompted to think about the option and then press the done button, moving them onto the next part of the exercise. If a done button is not pressed after a period of time, the user is prompted to press the button and continue on with the exercise
Data collected here includes the time to press each done button and the total time the user spent on the screen.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) Activity`	`activity` The instance of the current Activity
`(package private) SSCallback`	`callback` The instance of the `SSCallback` that allows this fragment to communicate with the parent activity.
`(package private) java.lang.String`	`d1Time` String representing the values of the times until each done button was pressed.
`(package private) java.lang.String`	`d2Time` String representing the values of the times until each done button was pressed.
`(package private) java.lang.String`	`d3Time` String representing the values of the times until each done button was pressed.
`(package private) boolean`	`done` A boolean value indicating if `done3` has been pressed.
`(package private) ImageView`	`done1` The TextViews of all three done buttons.
`(package private) ImageView`	`done2` The TextViews of all three done buttons.
`(package private) ImageView`	`done3` The TextViews of all three done buttons.
`(package private) int`	`DURATION_MACRO` An int for the length of the animation.
`(package private) boolean`	`first` The boolean values indicating what done buttons have been pressed.
`(package private) boolean`	`last` The boolean values indicating what done buttons have been pressed.
`(package private) TextView`	`letter` The TextViews of the options, the letter of the option, and the problem the user it working on.
`(package private) TextView`	`option` The TextViews of the options, the letter of the option, and the problem the user it working on.
`(package private) TextView`	`problem` The TextViews of the options, the letter of the option, and the problem the user it working on.
`(package private) SSTimer`	`prompt` The instances of the `SSTimer` used for retrieving timing values for this Fragment.
`(package private) SSJsonReader`	`reader` The instance of the `SSJsonReader` class that reads in the dynamic content for the application.
`(package private) boolean`	`second` The boolean values indicating what done buttons have been pressed.
`(package private) Animation`	`slide` The instance of the animation.
`(package private) boolean`	`temp1` The boolean values indicating what the current session is.
`(package private) boolean`	`temp2` The boolean values indicating what the current session is.
`(package private) SSTimer`	`timer` The instances of the `SSTimer` used for retrieving timing values for this Fragment.
`(package private) View`	`view` The instance of the current View
`(package private) boolean`	`voComplete` A boolean value indicating when the `voMediaPlayer` has finished playing.
`(package private) MediaPlayer`	`voMediaPlayer` The instance of voice over MediaPlayer
`(package private) java.lang.String`	`voPrompt` Strings for the paths to the audio files for the voice over and for the prompt.
`(package private) java.lang.String`	`voString` Strings for the paths to the audio files for the voice over and for the prompt.

Constructor Summary

Constructors
Constructor and Description
`Imagine(SSJsonReader reader, int run)` The constructor saves what template type this Fragment is a part of and copies the instance of the `SSJsonReader` into memory.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`approveNext()` This method checks to see if the voice over has been completed and and the third done button has been pressed
`void`	`onAttach(Activity activity)` This class uses the onAttach method of the android life cycle to save an instance of the activity and to implement the interface between the main activity and this fragment activity
`void`	`onClick(View v)` This method is called when a done button has been pressed by the user.
`void`	`onCompletion(MediaPlayer mp)` This method changes the value within `voComplete` to indicate the voice over file has finished playing.
`View`	`onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)` This method is called by the system to inflate the layout for the Imagine screen.
`void`	`onDestroy()` All data is saved within this method and memory with the `voMediaPlayer` is released.
`void`	`setPrompt()` This method sets the timer listener for the `prompt` `SSTimer`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - activity
```
Activity activity
```
    The instance of the current Activity
  - callback
```
SSCallback callback
```
    The instance of the SSCallback that allows this fragment to communicate with the parent activity.
  - d1Time
```
java.lang.String d1Time
```
    String representing the values of the times until each done button was pressed.
  - d2Time
```
java.lang.String d2Time
```
    String representing the values of the times until each done button was pressed.
  - d3Time
```
java.lang.String d3Time
```
    String representing the values of the times until each done button was pressed.
  - done
```
boolean done
```
    A boolean value indicating if done3 has been pressed. Default value = false;
  - done1
```
ImageView done1
```
    The TextViews of all three done buttons.
  - done2
```
ImageView done2
```
    The TextViews of all three done buttons.
  - done3
```
ImageView done3
```
    The TextViews of all three done buttons.
  - DURATION_MACRO
```
int DURATION_MACRO
```
    An int for the length of the animation.
  - first
```
boolean first
```
    The boolean values indicating what done buttons have been pressed. Default value = false;
  - last
```
boolean last
```
    The boolean values indicating what done buttons have been pressed. Default value = false;
  - letter
```
TextView letter
```
    The TextViews of the options, the letter of the option, and the problem the user it working on.
  - option
```
TextView option
```
    The TextViews of the options, the letter of the option, and the problem the user it working on.
  - problem
```
TextView problem
```
    The TextViews of the options, the letter of the option, and the problem the user it working on.
  - prompt
```
SSTimer prompt
```
    The instances of the SSTimer used for retrieving timing values for this Fragment.
  - reader
```
SSJsonReader reader
```
    The instance of the SSJsonReader class that reads in the dynamic content for the application.
  - second
```
boolean second
```
    The boolean values indicating what done buttons have been pressed. Default value = false;
  - slide
```
Animation slide
```
    The instance of the animation.
  - temp1
```
boolean temp1
```
    The boolean values indicating what the current session is. Default value = false;
  - temp2
```
boolean temp2
```
    The boolean values indicating what the current session is. Default value = false;
  - timer
```
SSTimer timer
```
    The instances of the SSTimer used for retrieving timing values for this Fragment.
  - view
```
View view
```
    The instance of the current View
  - voComplete
```
boolean voComplete
```
    A boolean value indicating when the voMediaPlayer has finished playing. Default value = false;
  - voMediaPlayer
```
MediaPlayer voMediaPlayer
```
    The instance of voice over MediaPlayer
  - voPrompt
```
java.lang.String voPrompt
```
    Strings for the paths to the audio files for the voice over and for the prompt.
  - voString
```
java.lang.String voString
```
    Strings for the paths to the audio files for the voice over and for the prompt.
- Constructor Detail
  - Imagine
```
public Imagine(SSJsonReader reader,
               int run)
```
    The constructor saves what template type this Fragment is a part of and copies the instance of the SSJsonReader into memory.
    
    Parameters:
    
    reader - The instance of the SSJsonReader
    
    run - The integer representation of the corresponding Template the Fragment is a part of.
- Method Detail
  - approveNext
```
public boolean approveNext()
```
    This method checks to see if the voice over has been completed and and the third done button has been pressed
    
    Returns:
    
    true if voice over is completed and third done button pressed
    false otherwise
  - onAttach
```
public void onAttach(Activity activity)
```
    This class uses the onAttach method of the android life cycle to save an instance of the activity and to implement the interface between the main activity and this fragment activity
  - onClick
```
public void onClick(View v)
```
    This method is called when a done button has been pressed by the user. Once a button has been pressed, the time to press that button is recorded. The prompt SSTimer is then started and the countdown begun. If the SSTimer reaches 20 seconds then the prompt audio is played. If the next button is pressed before 20 seconds then the SSTimer is restarted. Once a button has been pressed, its corresponding boolean is set to true so nothing happens upon subsequent presses. Once the last done button has been pressed,the Fragment indicates to its parent activity that the next button can now be visible to the user and the user has completed all required elements within the Fragment.
  - onCompletion
```
public void onCompletion(MediaPlayer mp)
```
    This method changes the value within voComplete to indicate the voice over file has finished playing. If the final done button has been pressed, the Fragment indicates to its parent activity that the next button can now be visible to the user and the user has completed all required elements within the Fragment.
  - onCreateView
```
public View onCreateView(LayoutInflater inflater,
                         ViewGroup container,
                         Bundle savedInstanceState)
```
    This method is called by the system to inflate the layout for the Imagine screen. All Views are associated with their ids within the fragment and the voice over is loaded, and the timer is started. Listeners are assigned. The dynamic facts, title, and problem restatement are loaded within this method.
  - onDestroy
```
public void onDestroy()
```
    All data is saved within this method and memory with the voMediaPlayer is released.
  - setPrompt
```
public void setPrompt()
```
    This method sets the timer listener for the prompt SSTimer. Once the timer has finished, the media player will play the selected prompt audio file.

Class Imagine

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

activity

callback

d1Time

d2Time

d3Time

done

done1

done2

done3

DURATION_MACRO

first

last

letter

option

problem

prompt

reader

second

slide

temp1

temp2

timer

view

voComplete

voMediaPlayer

voPrompt

voString

Constructor Detail

Imagine

Method Detail

approveNext

onAttach

onClick

onCompletion

onCreateView

onDestroy

setPrompt