Options

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

```
public class Options
extends Fragment
```
The Options Fragment is responsible for displaying the options screen to the user. The options screen consists of 4 options and 4 corresponding facts. When the user selects an option, it is then highlighted and the option fact is then displayed underneath the option. If the option is then de-selected, the highlight is removed and the option fact is grayed out but still visible to the user. The user must select two options before proceeding. If the user selects another option after selecting two, the first option they selected is de-selected.
Data collected here includes which options were selected, the time to select them, 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) boolean`	`done` A boolean value indicating if exactly two options have been selected.
`(package private) TextView`	`fact1` The TextViews of each of the different facts for each option.
`(package private) TextView`	`fact2` The TextViews of each of the different facts for each option.
`(package private) TextView`	`fact3` The TextViews of each of the different facts for each option.
`(package private) TextView`	`fact4` The TextViews of each of the different facts for each option.
`(package private) TextView[]`	`facts` TextView arrays of the options and facts.
`(package private) FrameLayout[]`	`highlights` FrameLayout array of the option highlights.
`(package private) FrameLayout`	`o1Highlight` The TextViews of each of the different highlights behind each option.
`(package private) FrameLayout`	`o2Highlight` The TextViews of each of the different highlights behind each option.
`(package private) FrameLayout`	`o3Highlight` The TextViews of each of the different highlights behind each option.
`(package private) FrameLayout`	`o4Highlight` The TextViews of each of the different highlights behind each option.
`(package private) TextView`	`option1` The TextViews of each of the different options on the screen related to the problem choice the user selected.
`(package private) TextView`	`option2` The TextViews of each of the different options on the screen related to the problem choice the user selected.
`(package private) TextView`	`option3` The TextViews of each of the different options on the screen related to the problem choice the user selected.
`(package private) TextView`	`option4` The TextViews of each of the different options on the screen related to the problem choice the user selected.
`(package private) int`	`optionCounter` an int representing how many options have been selected.
`(package private) TextView[]`	`options` TextView arrays of the options and facts.
`(package private) java.util.Queue<java.lang.Integer>`	`optionsQueue` A Queue containing the indices of which options were selected.
`(package private) java.lang.String[]`	`opts` A String[] containing the options for the problem choice.
`(package private) java.lang.String[]`	`optTimes` A String[] containing the timing data for each individual option.
`(package private) TextView`	`problem` The TextView displaying the current problem the user is working on
`(package private) SSJsonReader`	`reader` The instance of the `SSJsonReader` class that reads in the dynamic content for the application.
`(package private) java.lang.Boolean[]`	`shown` A boolean[] indicating which facts were selected by the user.
`(package private) boolean`	`temp1` Boolean values corresponding to which template the user is in.
`(package private) boolean`	`temp2` Boolean values corresponding to which template the user is in.
`(package private) SSTimer`	`timer` The instance 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

Constructor Summary

Constructors
Constructor and Description
`Options(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 two options have been selected
`void`	`checkNext()` This method checks if the conditions for the next button are met.
`private void`	`deselect(int deselect)` This method removes the option corresponding to the passed in index value in the options queue.
`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 an option has been selected 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 Options screen.
`void`	`onDestroy()` All data is saved within this method and memory with the `voMediaPlayer` is released.
`private void`	`select(int select)` This method adds the selected option to the options queue.
`void`	`setScreen()` This method populates each options and facts TextView with content from the `reader` class and sets all facts to be invisible.
`void`	`unselectLast()` This method removes the head of the options queue.

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.
  - done
```
boolean done
```
    A boolean value indicating if exactly two options have been selected. Default value = false;
  - fact1
```
TextView fact1
```
    The TextViews of each of the different facts for each option.
  - fact2
```
TextView fact2
```
    The TextViews of each of the different facts for each option.
  - fact3
```
TextView fact3
```
    The TextViews of each of the different facts for each option.
  - fact4
```
TextView fact4
```
    The TextViews of each of the different facts for each option.
  - facts
```
TextView[] facts
```
    TextView arrays of the options and facts. These items are built dynamically from the reader instance. I could simplify the globals down but I'm too afraid to do that because everything already works.
  - highlights
```
FrameLayout[] highlights
```
    FrameLayout array of the option highlights.
  - o1Highlight
```
FrameLayout o1Highlight
```
    The TextViews of each of the different highlights behind each option.
  - o2Highlight
```
FrameLayout o2Highlight
```
    The TextViews of each of the different highlights behind each option.
  - o3Highlight
```
FrameLayout o3Highlight
```
    The TextViews of each of the different highlights behind each option.
  - o4Highlight
```
FrameLayout o4Highlight
```
    The TextViews of each of the different highlights behind each option.
  - option1
```
TextView option1
```
    The TextViews of each of the different options on the screen related to the problem choice the user selected.
  - option2
```
TextView option2
```
    The TextViews of each of the different options on the screen related to the problem choice the user selected.
  - option3
```
TextView option3
```
    The TextViews of each of the different options on the screen related to the problem choice the user selected.
  - option4
```
TextView option4
```
    The TextViews of each of the different options on the screen related to the problem choice the user selected.
  - optionCounter
```
int optionCounter
```
    an int representing how many options have been selected.
  - options
```
TextView[] options
```
    TextView arrays of the options and facts. These items are built dynamically from the reader instance. I could simplify the globals down but I'm too afraid to do that because everything already works.
  - optionsQueue
```
java.util.Queue<java.lang.Integer> optionsQueue
```
    A Queue containing the indices of which options were selected.
  - opts
```
java.lang.String[] opts
```
    A String[] containing the options for the problem choice. Built dynamically from the reader instance.
  - optTimes
```
java.lang.String[] optTimes
```
    A String[] containing the timing data for each individual option.
  - problem
```
TextView problem
```
    The TextView displaying the current problem the user is working on
  - reader
```
SSJsonReader reader
```
    The instance of the SSJsonReader class that reads in the dynamic content for the application.
  - shown
```
java.lang.Boolean[] shown
```
    A boolean[] indicating which facts were selected by the user. Defaults values = false;
  - temp1
```
boolean temp1
```
    Boolean values corresponding to which template the user is in.
  - temp2
```
boolean temp2
```
    Boolean values corresponding to which template the user is in.
  - timer
```
SSTimer timer
```
    The instance 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
- Constructor Detail
  - Options
```
public Options(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 two options have been selected
    
    Returns:
    
    true if voice over is completed and two options selected
    false otherwise
  - checkNext
```
public void checkNext()
```
    This method checks if the conditions for the next button are met. If only two options are selected, then the done value is set to true. Otherwise it is set to false. approveNext() is then called to check if the media player has completed and only two options have been selected. If it returns true, the next button is displayed. Otherwise it stays false.
  - deselect
```
private void deselect(int deselect)
```
    This method removes the option corresponding to the passed in index value in the options queue. Its highlight is set invisible and the facts are set to .5 alpha. The value in the shown array is set to false. checkNext() is called to see if the next button can be displayed.
    
    Parameters:
    
    deselect - an integer corresponding to the index of the selected option in the options array
  - 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 an option has been selected by the user. Once an option has been selected, the select method is called with the index of that option. After it has been added, the size of the queue is checked to see if there are more than two options in it. If there are, the deselect method is called on that index. If the user presses the option again after selecting it, deselect it called on that index. Once two options have been selected,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 two options have been selected, 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 Options 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.
  - select
```
private void select(int select)
```
    This method adds the selected option to the options queue. The facts and highlight for the option is set visible. The index in the shown array is set to true and the time is recorded for that option. checkNext() is then called to see if the next button can be displayed.
    
    Parameters:
    
    select - an integer corresponding to the index of the selected option in the options array
  - setScreen
```
public void setScreen()
```
    This method populates each options and facts TextView with content from the reader class and sets all facts to be invisible.
  - unselectLast
```
public void unselectLast()
```
    This method removes the head of the options queue. It is called when a third option has been selected. The head of the queue is removed, its fact is set to .5 alpha and highlight set to invisible. The corresponding index value in the shown array is set to false. checkNext() is called to see if the next button can be displayed.
    
    Parameters:
    
    select - an integer corresponding to the index of the selected option in the options array

Class Options

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

activity

callback

done

fact1

fact2

fact3

fact4

facts

highlights

o1Highlight

o2Highlight

o3Highlight

o4Highlight

option1

option2

option3

option4

optionCounter

options

optionsQueue

opts

optTimes

problem

reader

shown

temp1

temp2

timer

view

voComplete

voMediaPlayer

Constructor Detail

Options

Method Detail

approveNext

checkNext

deselect

onAttach

onClick

onCompletion

onCreateView

onDestroy

select

setScreen

unselectLast