Template1

java.lang.Object
- Activity
- - com.example.staysafe.Template1

All Implemented Interfaces:

SSCallback
```
public class Template1
extends Activity
implements SSCallback
```
The activity is an extension of the Template2 activity. This class loads the base layout for Template 1 and then proceeds to load in fragments for the rest of the application. Furthermore, this class performs high level actions such as restarting the StaySafe application, showing errors to the user, allowing the administrative user to exit the application early, saving data and then outputting that data. This application also creates an instance of the SSJsonReader class and the proceeds to pass that instance throughout the run of the application.
This class extends Template2 by allowing the use of a "floating hand". This hand allows that application to demonstrate functionality of the application by moving the hand and then simulating screen presses.

Field Summary

Fields
Modifier and Type	Field and Description
`private float`	`ANIMATION_DISTANCE` The distance the floating hand travels during the press animation.
`private int`	`ANIMATION_LENGTH` The length of the floating hand animation.
`(package private) int`	`density` The current pixel density of the device.
`(package private) java.lang.String`	`fileName` The filename of the file to be exported.
`(package private) java.lang.String`	`finalHeaders` Strings used to save the output data.
`(package private) java.lang.String`	`finalValues` Strings used to save the output data.
`(package private) boolean`	`firstrun` used to to determine if this is the first time the `moveHand(float, float, int)` method has been run.
`(package private) LayoutParams`	`lp` Current instance of the LayoutParameters for the device.s
`(package private) int`	`maxX` The maximum values for the screen orientation.
`(package private) int`	`maxY` The maximum values for the screen orientation.
`(package private) ImageView`	`nextButton` The ImageView containing the "next button"
`(package private) ImageView`	`pointer` The ImageView containing the "floating hand"
`(package private) SSJsonReader`	`reader` The instance of the `SSJsonReader` to be passed to all of the Fragments incorporated in Template 1.
`private boolean`	`secondUse` Indicates if this is the second time the `Think` Fragment has been executed for this template
`(package private) int`	`statusBarHeight` the height of the statues bar for the current device.
`(package private) Stop`	`stopFragment` The instance of the `Stop` fragment saved so the `ExitUtility` cannot be performed when `onLongClick(View)` occurs.

Constructor Summary

Constructors
Constructor and Description

Template1()

Constructors
Constructor and Description
`Template1()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addData(java.lang.String key, java.lang.String value)` Saves key value pairs in order to have them output at the end of the session.
`void`	`addOutputFile()` Causes all saved items (`finalHeaders` and `finalValues`) from the session to be compiled and saved in the root:/StaySafe/Data/ directory.
`void`	`animateHand(float xDelta, float yDelta, int angle, java.lang.Runnable r)` Animates the floating hand used in `Template1` to simulate a user touch.
`void`	`animateHand(int xDelta, int yDelta, int angle, java.lang.Runnable r, boolean b)` Convenience method similar to `animateHand(float, float, int, Runnable)` This method takes an elements absolute position on the screen and translates those values into percentages which can be used by `animateHand(float, float, int, Runnable)` This allows the pointer to be moved around the screen dynamically in case the object needing to be "touched" is not allows in the same position.
`void`	`animateHandNext()` Convenience method to animate the hand to press the nextbuton.
`void`	`displaySetup()` finds and determines different characteristics of the current display environment.
`private int`	`getStatusBarHeight()` returns the height of the status bar on the active device
`void`	`handVisible(boolean bool)` Determines the visibility of the "floating hand" used in Template 1
`void`	`move(int i)` Not used in this class.
`void`	`moveHand(float x, float y, int angle)` Moves the "floating hand" to this position.
`void`	`nextClickable(boolean clickable)` Makes the next button clickable.
`void`	`nextVisible(boolean visible)` Makes the next button visible to the user.
`void`	`onBackPressed()` Method run when back button is pressed.
`protected void`	`onCreate(Bundle savedInstanceState)` Responsible for inflating the Template 1 view elements.
`boolean`	`onLongClick(View v)` Called by the Android system when the StaySafe logo has been long pressed.
`void`	`onNext(View v)` Called when the user presses the next button.
`void`	`restart()` Closes the current Activity and loads the `Login` Activity to restart the application.
`void`	`showError(java.lang.String error)` Shows an error to the user.
`void`	`showRouting(boolean b)` Not used in this class.
`void`	`stopRoutingTimer()` Not used in this class.

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

- Field Detail
  - ANIMATION_DISTANCE
```
private float ANIMATION_DISTANCE
```
    The distance the floating hand travels during the press animation.
  - ANIMATION_LENGTH
```
private int ANIMATION_LENGTH
```
    The length of the floating hand animation.
  - density
```
int density
```
    The current pixel density of the device.
  - fileName
```
java.lang.String fileName
```
    The filename of the file to be exported.
  - finalHeaders
```
java.lang.String finalHeaders
```
    Strings used to save the output data.
  - finalValues
```
java.lang.String finalValues
```
    Strings used to save the output data.
  - firstrun
```
boolean firstrun
```
    used to to determine if this is the first time the moveHand(float, float, int) method has been run.
  - lp
```
LayoutParams lp
```
    Current instance of the LayoutParameters for the device.s
  - maxX
```
int maxX
```
    The maximum values for the screen orientation.
  - maxY
```
int maxY
```
    The maximum values for the screen orientation.
  - nextButton
```
ImageView nextButton
```
    The ImageView containing the "next button"
  - pointer
```
ImageView pointer
```
    The ImageView containing the "floating hand"
  - reader
```
SSJsonReader reader
```
    The instance of the SSJsonReader to be passed to all of the Fragments incorporated in Template 1.
  - secondUse
```
private boolean secondUse
```
    Indicates if this is the second time the Think Fragment has been executed for this template
  - statusBarHeight
```
int statusBarHeight
```
    the height of the statues bar for the current device.
  - stopFragment
```
Stop stopFragment
```
    The instance of the Stop fragment saved so the ExitUtility cannot be performed when onLongClick(View) occurs.
- Constructor Detail
  - Template1
```
public Template1()
```
- Method Detail
  - addData
```
public void addData(java.lang.String key,
                    java.lang.String value)
```
    Saves key value pairs in order to have them output at the end of the session. (Saves data into finalHeaders and finalValues) Concatenates two strings, one for the keys and the other for the values. Provides a means for the fragments to communicate and have data generated within the Fragment be saved within the activity.
    
    Specified by:
    
    addData in interface SSCallback
    
    Parameters:
    
    key - The title of the value being passed
    
    value - The value associated with the key
  - addOutputFile
```
public void addOutputFile()
```
    Causes all saved items (finalHeaders and finalValues) from the session to be compiled and saved in the root:/StaySafe/Data/ directory.
    
    Specified by:
    
    addOutputFile in interface SSCallback
  - animateHand
```
public void animateHand(float xDelta,
                        float yDelta,
                        int angle,
                        java.lang.Runnable r)
```
    Animates the floating hand used in Template1 to simulate a user touch. This method call allows a Runnable to be passed. This allows the hand animation to act as it actually touched the object at the coordinates given
    
    Specified by:
    
    animateHand in interface SSCallback
    
    Parameters:
    
    xDelta - The x location the hand should be moved to at as a percentage of total screen size. No limits are set on the percentage.
    
    yDelta - The y location the hand should be moved to as a percentage of total screen size. No limits are set on the percentage.
    
    angle - The angle the hand show be rotated to during animation.
    
    r - The runnable that corresponds to the hand "pressing" something on the screen.
  - animateHand
```
public void animateHand(int xDelta,
                        int yDelta,
                        int angle,
                        java.lang.Runnable r,
                        boolean b)
```
    Convenience method similar to animateHand(float, float, int, Runnable) This method takes an elements absolute position on the screen and translates those values into percentages which can be used by animateHand(float, float, int, Runnable) This allows the pointer to be moved around the screen dynamically in case the object needing to be "touched" is not allows in the same position.
    
    Specified by:
    
    animateHand in interface SSCallback
    
    Parameters:
    
    xDelta - The absolute x position the hand should be moved to
    
    yDelta - The absolute y position the hand should be moved to
    
    angle - The angle the hand should be rotated to
    
    r - The runnable that corresponds to the hand "pressing" something on the screen.
    
    b - fifth variable used to distinguish animateHand(float, float, int, Runnable) from this one. This variable has no affect on the method.
  - animateHandNext
```
public void animateHandNext()
```
    Convenience method to animate the hand to press the nextbuton.
    
    Specified by:
    
    animateHandNext in interface SSCallback
  - displaySetup
```
public void displaySetup()
```
    finds and determines different characteristics of the current display environment.
  - getStatusBarHeight
```
private int getStatusBarHeight()
```
    returns the height of the status bar on the active device
  - handVisible
```
public void handVisible(boolean bool)
```
    Determines the visibility of the "floating hand" used in Template 1
    
    Specified by:
    
    handVisible in interface SSCallback
    
    Parameters:
    
    bool - hand is visible if true; invisible if false.
  - move
```
public void move(int i)
```
    Not used in this class.
    
    Specified by:
    
    move in interface SSCallback
    
    Parameters:
    
    i - 1 - Video\n 2 - Game\n 3 - Facts
  - moveHand
```
public void moveHand(float x,
                     float y,
                     int angle)
```
    Moves the "floating hand" to this position.
    
    Specified by:
    
    moveHand in interface SSCallback
    
    Parameters:
    
    x - The x location the hand should be moved to at as a percentage of total screen size. No limits are set on the percentage.
    
    y - The y location the hand should be moved to as a percentage of total screen size. No limits are set on the percentage.
    
    angle - The angle the hand show be rotated to during animation.
  - nextClickable
```
public void nextClickable(boolean clickable)
```
    Makes the next button clickable.
    
    Parameters:
    
    clickable - clickable if true; not clickable if false.
  - nextVisible
```
public void nextVisible(boolean visible)
```
    Makes the next button visible to the user.
    
    Specified by:
    
    nextVisible in interface SSCallback
    
    Parameters:
    
    visible - If true, the next button will be made visible. If false, the next button will be made invisible.
  - onBackPressed
```
public void onBackPressed()
```
    Method run when back button is pressed. Removes back button functionality from application.
  - onCreate
```
protected void onCreate(Bundle savedInstanceState)
```
    Responsible for inflating the Template 1 view elements. This method retrieves all values saved by the Login screen. All Views are associated with their ids within the activity. Listeners are assigned.
  - onLongClick
```
public boolean onLongClick(View v)
```
    Called by the Android system when the StaySafe logo has been long pressed. Performs the ExitUtility.
  - onNext
```
public void onNext(View v)
```
    Called when the user presses the next button. This method is responsible for providing the path of screens to the application.
    
    Parameters:
    
    v - The view that cause this method to be executed.
  - restart
```
public void restart()
```
    Closes the current Activity and loads the Login Activity to restart the application.
    
    Specified by:
    
    restart in interface SSCallback
  - showError
```
public void showError(java.lang.String error)
```
    Shows an error to the user. See ErrorFragment
    
    Specified by:
    
    showError in interface SSCallback
    
    Parameters:
    
    error - The error message to be displayed.
  - showRouting
```
public void showRouting(boolean b)
```
    Not used in this class.
    
    Specified by:
    
    showRouting in interface SSCallback
    
    Parameters:
    
    b - visible if true invisible if false
  - stopRoutingTimer
```
public void stopRoutingTimer()
```
    Not used in this class.
    
    Specified by:
    
    stopRoutingTimer in interface SSCallback

Class Template1

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ANIMATION_DISTANCE

ANIMATION_LENGTH

density

fileName

finalHeaders

finalValues

firstrun

lp

maxX

maxY

nextButton

pointer

reader

secondUse

statusBarHeight

stopFragment

Constructor Detail

Template1

Method Detail

addData

addOutputFile

animateHand

animateHand

animateHandNext

displaySetup

getStatusBarHeight

handVisible

move

moveHand

nextClickable

nextVisible

onBackPressed

onCreate

onLongClick

onNext

restart

showError

showRouting

stopRoutingTimer