Ong Yan Chun (yaaanch) Project Portfolio

Provides a list of possible commands the user can type with brief descriptions.
Format: help

Provides detailed help for a specific command, including the parameters required.
Format: help COMMAND
Example:

When the user presses tab, the command word, or module code, or semester, or tag name will be autocompleted If there is only one possible completion, it will be filled immediately. If there is more than one possible completion, a menu of possible autocompletions is drawn that can be selected with the up and down buttons.

Expands a semester so that more details can be seen. Will display module titles, MC count, and their tags.
Format: expand SEMESTER
Example:

Expands all semesters so that more details can be seen. Will display module titles, MC count, and their tags.
Format: expandall

Collapses a semester so that most details are hidden. Will hide module titles, MC count, and their tags.
Format: collapse SEMESTER
Example:

Collapses all semesters so that most details are hidden. Will hide module titles, MC count, and their tags.
Format: collapseall

Changes the theme of the GUI. Existing themes are: light, dark, hacker, dawn.
Format: theme THEME_NAME

Examples:

Expanding and collapsing semesters will be fluidly animated.

Each module and tag can be assigned with a specific colour to allow more customisation.

The autocompletion of keywords is facilitated by AutocompleteTextField, which inherits from Textfield, and ModulePlannerAutocompleteSearch. AutocompleteTextField handles user input and changing the text in the text field. ModulePlannerAutocompleteSearch handles the autocorrect searching for keywords.

When the MainWindow is created, a CommandBox is created and added to the GUI. The CommandBox creates an AutocompleteTextField and it is added to the GUI. The AutocompleteTextField holds a ModulePlannerAutocompleteSearch.

CommandBox attaches a keyEvent listener to AutocompleteTextField that listens for the TAB key press, which starts the autocomplete process.

ModulePlannerAutocompleteSearch holds two sets of keywords, a set for commands and a set for arguments. These keywords are represented as SortedSet<String>. Within each input, the first word will be autocompleted with the set for commands, while subsequent words (separated by spaces) will be autocompleted with the set for arguments. An exception is the help command, in which the subsequent words will be autocompleted with the set for commands.

ModulePlannerAutocompleteSearch is constructed with a ReadOnlyModulePlanner. It is used to create the keyword sets. Hence, AutocompleteTextField is also constructed with a ReadOnlyModulePlanner to pass this down.

The following sequence diagram shows the creation of Autocomplete:

AutocompleteTextField holds the following public operations:

ModulePlannerAutocompleteSearch is never accessed by any external classes.

Given below is an example usage scenario of the AutocompleteTextField#handleAutocomplete() operation and how the autocomplete mechanism behaves at each step for commands.

Step 1. The user enters the beginning of a command into the GUI text field, for example "addt" for addtag. The user then presses the activation key TAB with begins the autocomplete process. The KeyEvent listener calls the AutocompleteTextField#handleAutocomplete() operation.

Step 2: AutocompleteTextField passes the input to ModulePlannerAutocompleteSearch, by calling ModulePlannerAutocompleteSearch#getSearchResults(String input). In ModulePlannerAutocompleteSearch, the text in the text field is checked. As it is the first word, the keywords set for commands is used. ModulePlannerAutocompleteSearch#performSearch(String input, SortedSet<String> keywords) is called to proceed with the search.

Step 3: This method finds search results, which is a subset from the keywords set for commands that begin with the input. This result is returned back through ModulePlannerAutocompleteSearch#getSearchResults(String input). AutocompleteTextField#handleAutocomplete() uses the search results to proceed. There are two possible scenarios that are described in Steps 4 and 5.

Step 4: If there is only one search result, AutocompleteTextField#setAutocompleteText(String searchResult) is called. Proceed to Step 6.

Step 5: If there is more than one search result, a menu will be created for the user to make a selection. This method will call the populateMenu(List<String> searchResult) method, and then show the menu if it is not showing. Then, focus will be requested from the first menu item in the menu. The populateMenu(List<String> searchResult) populates a ContextMenu with CustomMenuItem, which correspond to each search result. On action of the menu item, either through clicking or pressing the key ENTER while it is focused, AutocompleteTextField#setAutocompleteText(String searchResult) is called. Proceed to Step 6.

Step 6: AutocompleteTextField#setAutocompleteText(String searchResult) causes the input text to be changed to the search result and the caret positioned at the end of the line.

The autocomplete mechanism behaves similarly for arguments, except the argument set of keywords will be used. Furthermore, AutocompleteTextField#setAutocompleteText(String searchResult) will cause the input text to be changed to the text before the space concatenated with a space and the search result and the caret is positioned at the end of the line. This change replicates autocompleting only the last word without erasing previous terms.

The following activity diagram shows how the autocomplete works: