com.example.staysafe

Interface SSCallback

All Known Implementing Classes:

Template1, Template2, Template3

public interface SSCallback

An interface designed to facilitate the interactions of the StaySafe Fragments and their current Template's Activity. This interface allows Fragments to display errors, control the next buttons availability to the user, save data to be output, animate the "floating hand", the ability for the application to be restarted and finally to output the accumulated user data. Additionally, this interface allows the Menu3 Fragment to signal to Template3 what screen should be loaded in next, to show the routing buttons to the user associated with Template 3, and cancel any routing previously instantiated within Template 3.

Method Summary

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 from the session to be compiled and saved in the root:/StaySafe/Data/ directory.
void	animateHand(float x, float y, int angle, java.lang.Runnable runnable) Animates the floating hand used in Template1 to simulate a user touch.
void	animateHand(int i, int j, int k, java.lang.Runnable runnable, 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 of #animateHand(int, int, int, Runnable) Animates the floating hand used in Template1 to press the next button.
void	handVisible(boolean b) Sets the "floating hand" visibility in Template1
void	move(int i) Used to signal to Template3 what Fragment should be loaded next.
void	moveHand(float x, float y, int angle) Moves the "floating hand" to this position.
void	nextVisible(boolean visible) Makes the next button visible to the user.
void	restart() Causes all saved items from the current session to be lost and forces the application to exit back to the Login screen.
void	showError(java.lang.String error) Shows an error to the user.
void	showRouting(boolean b) Shows the routing elements (Go to Survey and Go to Menu) buttons.
void	stopRoutingTimer() Method used by Template3 Fragments to cancel the goto survey button being made visible from the showRouting(boolean) call if applicable

Method Detail

addData

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. Each Template concatenates two strings, one for the keys and the other for the values. This method provides a means for the Templates fragments to communicate upwards and have data generated within the Fragment be saved within the creating activity.

Parameters:

key - The title of the value being passed

value - The value associated with the key

addOutputFile

void addOutputFile()

Causes all saved items from the session to be compiled and saved in the root:/StaySafe/Data/ directory.

animateHand

void animateHand(float x,
                 float y,
                 int angle,
                 java.lang.Runnable runnable)

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

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.

runnable - The runnable that corresponds to the hand "pressing" something on the screen.

animateHand

void animateHand(int i,
                 int j,
                 int k,
                 java.lang.Runnable runnable,
                 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.

Parameters:

i - The absolute x position the hand should be moved to

j - The absolute y position the hand should be moved to

k - The angle the hand should be rotated to

runnable - 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

void animateHandNext()

Convenience method of #animateHand(int, int, int, Runnable) Animates the floating hand used in Template1 to press the next button.

handVisible

void handVisible(boolean b)

Sets the "floating hand" visibility in Template1

Parameters:

b - visible if true invisible if false

move

void move(int i)

Used to signal to Template3 what Fragment should be loaded next.

Parameters:

i - 1 - Video\n 2 - Game\n 3 - Facts

moveHand

void moveHand(float x,
              float y,
              int angle)

Moves the "floating hand" to this position. Used only in Template1.

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.

nextVisible

void nextVisible(boolean visible)

Makes the next button visible to the user.

Parameters:

visible - If true, the next button will be made visible. If false, the next button will be made invisible.

restart

void restart()

Causes all saved items from the current session to be lost and forces the application to exit back to the Login screen.

showError

void showError(java.lang.String error)

Shows an error to the user. See ErrorFragment

Parameters:

error - The error message to be displayed.

showRouting

void showRouting(boolean b)

Shows the routing elements (Go to Survey and Go to Menu) buttons. When called with a true value. The Go to Menu button is immediately visible. The Go to Survey button becomes visible 5 seconds later if the user stays on the same screen this was called from. If the user did change, the survey button will no longer become visible from this call. If the application has this method called after visiting all Template3 screens, this method should make only the "next" button visible as opposed to the survey and menus buttons

Parameters:

b - visible if true invisible if false

stopRoutingTimer

void stopRoutingTimer()

Method used by Template3 Fragments to cancel the goto survey button being made visible from the showRouting(boolean) call if applicable