AutoWord - accessibilitysoftwarehub/OpenSourceWindowsGazeControl GitHub Wiki

General Information

Name: AutoWord

Description: This class represents each word in the dictionary and how frequent this word is.

Purpose: To store information on a word in the dictionary.

Full Description: Each AutoWord contains the word, how frequent the word is and the distance from the current word.

Note:

Method Descriptions

CompareTo: This method is used when sorting the AutoWords. Because the AutoWord class has multiple methods, it can't just use the default sort method. This method tells the list sort() method how to sort AutoWords. if the two words have the same distance it will go alphabetically. Otherwise it will just sort by the distance.

Public Methods: Each variable has a get and set method. The get from Frequency and Word is used to calculate distance. The CurrentDistance is updated when a new word is being typed.