UI Specification

Introduction

The UI, described in this document, specifies the app activity classes which currently have no functionality specified. As development of this project progresses, UI class specifications are moved out of this document, into a functionality document which specifies the UI and the functionality of the activity.

The functionality specification documents are kept in the functionality folder. The file Functionality.html gives a detailed overview of the functionality specification documents.

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

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/activities
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 at runtime.

The activities with no functionality specified yet are as follows:

Level 2 Activities

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
help	button	btnHelp

Class name: ImportExportStoreActivity
Title:Import/Export Store

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

Level 3 Activities

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
help	button	btnHelp

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
help	button	btnHelp

Class name: DeleteEntryActivity
Title:Delete Entry

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

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
help	button	btnHelp

Class name: SearchEntriesActivity
Title:Find Entry

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

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 have a valid email address syntax,
url must have a valid http url syntax.
name starts with an uppercase.
name is unique, name is case insensitive for purposes of uniqueness. For example name Name and NAME are all treated as the same in terms of sorting and uniqueness, so only one of name, Name or NAME can be present in the list of entries.
name is not null,