goodViberations: UI Specification

Introduction

The UI, described in this document, is used to render the data to the end user. The UI facilitates the user's interaction (CRUD) with the data. The actual work of creating new data, retrieving data, updating data, deleting data, and ensuring data integrity is specified in Functionality.html.

The data structures used in this app are described in DataLayer.html

This document lists the activities in the app, the widgets present in each activity.

Activity design

All the activity classes should be in the package com.j3t.dataentryapp.ui.activities
All the activity classes should be in the folder src/main/java/com/j3t/dataentryapp/ui/act
The title is displayed at the top of the activity's view.
The activity widgets are placed within a vertically scrolling view. This allows the activity's contents to be viewable by the user in portrait and landscape modes.
Each widget is a class member variable, this allows for functionality to be added to alter the widget's appearance.

The activities wanted in this app are as follows:

Level 1 Activity

Class name: MainActivity
Title: Options

Widget label	Widget type	Widget name
open store	button	btnOpenStore
create new store	button	btnCreateNewStore
change store password	button	btnChangeStorePassword
clear existing store	button	btnClearExistingStore
import/export store	button	btnImportExportStore
about	button	btnAbout
help	button	btnHelp

Level 2 Activities

Class name: OpenStoreActivity
Title: Open Store

Widget label	Widget type	Widget name
password	text field	txtPassword
memorable date	text field	txtMemorableDate
open store	button	btnOpenStore
back	button	btnBack

Class name: CreateNewStoreActivity
Title: Create Store

Widget label	Widget type	Widget name
password	text field	txtPassword
memorable date	text field	txtMemorableDate
confirm password	text field	txtConfirmPassword
confirm memorable date	text field	txtConfirmMemorableDate
create store	button	btnCreateStore
back	button	btnBack

Class name: ChangeStorePasswordActivity
Title:Change Store Password

Widget label	Widget type	Widget name
new password	text field	txtNewPassword
new password	text field	txtNewPassword
new memorable date	text field	txtNewMemorableDate
confirm new password	text field	txtConfirmNewPassword
confirm new memorable date	text field	txtConfirmNewMemorableDate
save changes	button	btnSaveChanges
back	button	btnBack

Class name: ImportExportStoreActivity
Title:Import/Export Store

Widget label	Widget type	Widget name
import store	button	btnImportStore
export store	button	btnExportStore
back	button	btnBack

Class name: AboutActivity
Title:About

Widget label	Widget type	Widget name
about text	html text	htmlText
ok	button	btnOk
back	button	btnBack

Class name: HelpActivity
Title:Help

Widget label	Widget type	Widget name
help text	html text	htmlText
ok	button	btnOk
back	button	btnBack

Level 3 Activities

Class name: ListEntriesActivity
Title:List Entries

Widget label	Widget type	Widget name
entries	vertically scrolling list	vlsEntryNames
new entry	button	btnNewEntry
search entryNames	button	btnSearchEntryNames
back	button	btnBack

Level 4 Activities

Class name: ViewEntryActivity
Title:View Entry

Widget label	Widget type	Widget name
entry name	text	lblEntryName
creation date and time	text	lblDateTime
last modified date and time	text	lblLastModifiedDateTime
notes	multiline text	mblNotes
password	text	lblPassword
fields	vertical list of single line text entries	vlsFields
delete	button	btnDelete
edit	button	btnEdit
back	button	btnBack

Class name: AddEntryActivity
Title:New Entry

Widget label	Widget type	Widget name
entry name	text field	txtEntryName
creation date and time	text	lblDateTime
last modified date and time	text	lblLastModifiedDateTime
notes	multiline text area	mtxNotes
password	text field	txtPassword
fields	vertical list of single line text field entries	vlsFields
delete field	button	btnDelField
add field	button	btnAddField
save	button	btnSave
back	button	btnBack

Class name: DeleteEntryActivity
Title:Delete Entry

Widget label	Widget type	Widget name
entry name	text	lblEntryName
confirm delete	button	btnConfirmDelete
back	button	btnBack

Class name: EditEntryActivity
Title:Edit Entry

Widget label	Widget type	Widget name
entry name	text field	txtEntryName
creation date and time	text	lblDateTime
last modified date and time	text	lblLastModifiedDateTime
notes	multiline text area	mtxNotes
password	text field	txtPassword
list of detail fields	vertical list of single line text field entries	lstDetailFields
delete field	button	btnDelField
add field	button	btnAddField
save	button	btnSave
back	button	btnBack

Class name: SearchEntriesActivity
Title:Find Entry

Widget label	Widget type	Widget name
entry name	text field	txtEntryName
search	button	btnSearch
back	button	btnBack

Misc. definitions

Some terms used in this project are defined below:

Entry

An entry is defined to be a set of text fields, each field has a name and a value. Some fields are unique to an entry type, some are common to all entries. Some field values reflect a data type, and so have a syntax associated with them. For example, email must be a valur email address syntax, url must be a valid http url syntax, name starts with an uppercase.