Skip navigation links
A B C D E F G I K M N O P R S V 

A

AbstractView - Class in io.bretty.console.view
The parent class of all View classes, which defines infrastructure attributes (e.g.
AbstractView(String, String) - Constructor for class io.bretty.console.view.AbstractView
default constructor
AbstractView(String, String, ViewConfig) - Constructor for class io.bretty.console.view.AbstractView
create a view with your own choice of words
actionCanceled() - Method in class io.bretty.console.view.AbstractView
print this.viewConfig.actionCanceledMessage
actionFailed() - Method in class io.bretty.console.view.AbstractView
print this.viewConfig.actionFailedMessage
actionSuccessful() - Method in class io.bretty.console.view.AbstractView
print this.viewConfig.actionSuccessfulMessage
ActionView - Class in io.bretty.console.view
The view that is used for a custom leaf functionality implementation.
ActionView(String, String) - Constructor for class io.bretty.console.view.ActionView
 
ActionView(String, String, ViewConfig) - Constructor for class io.bretty.console.view.ActionView
 
addMenuItem(AbstractView) - Method in class io.bretty.console.view.MenuView
Add an entry to the menu; similar to remove, setter and getter

B

build() - Method in class io.bretty.console.view.ViewConfig.Builder
 
Builder() - Constructor for class io.bretty.console.view.ViewConfig.Builder
 

C

confirmDialog(String) - Method in class io.bretty.console.view.AbstractView
Show confirmation dialog; if confirmed, return; else, print this.viewConfig.actionCanceledMessage
copy() - Method in class io.bretty.console.view.ViewConfig
 

D

DEFAULT - Static variable in class io.bretty.console.view.ViewConfig
 
DEFAULT_ACTION_CANCELED_MESSAGE - Static variable in class io.bretty.console.view.ViewConfig
 
DEFAULT_ACTION_FAILED_MESSAGE - Static variable in class io.bretty.console.view.ViewConfig
 
DEFAULT_ACTION_SUCCESSFUL_MESSAGE - Static variable in class io.bretty.console.view.ViewConfig
 
DEFAULT_BACK_MENU_NAME - Static variable in class io.bretty.console.view.ViewConfig
 
DEFAULT_CONFIRM_OPTION - Static variable in class io.bretty.console.view.ViewConfig
 
DEFAULT_INPUT_ERROR_MESSAGE - Static variable in class io.bretty.console.view.ViewConfig
 
DEFAULT_MENU_SELECTION_MESSAGE - Static variable in class io.bretty.console.view.ViewConfig
 
DEFAULT_PAUSE_MESSAGE - Static variable in class io.bretty.console.view.ViewConfig
 
DEFAULT_QUIT_MENU_NAME - Static variable in class io.bretty.console.view.ViewConfig
 
DEFAULT_QUIT_MESSAGE - Static variable in class io.bretty.console.view.ViewConfig
 
display() - Method in class io.bretty.console.view.AbstractView
display this view in the console
display() - Method in class io.bretty.console.view.ActionView
 
display() - Method in class io.bretty.console.view.MenuView
 

E

executeCustomAction() - Method in class io.bretty.console.view.ActionView
to create your custom ActionView subclass, implement this method to execute your custom logic between printing the title and go back to the parent view

F

format(int) - Method in interface io.bretty.console.view.IndexNumberFormatter
Given an index number of menu items in a menu (starting from 0), format it to a string.

G

getActionCanceledMessage() - Method in class io.bretty.console.view.ViewConfig
 
getActionFailedMessage() - Method in class io.bretty.console.view.ViewConfig
 
getActionSuccessfulMessage() - Method in class io.bretty.console.view.ViewConfig
 
getBackMenuName() - Method in class io.bretty.console.view.ViewConfig
 
getConfirmOption() - Method in class io.bretty.console.view.ViewConfig
 
getConfirmValidator() - Method in class io.bretty.console.view.ViewConfig
 
getIndexNumberFormatter() - Method in class io.bretty.console.view.ViewConfig
 
getInputErrorMessage() - Method in class io.bretty.console.view.ViewConfig
 
getMenuItems() - Method in class io.bretty.console.view.MenuView
 
getMenuSelectionMessage() - Method in class io.bretty.console.view.ViewConfig
 
getNameInParentMenu() - Method in class io.bretty.console.view.AbstractView
 
getParentView() - Method in class io.bretty.console.view.AbstractView
 
getPauseMessage() - Method in class io.bretty.console.view.ViewConfig
 
getQuitMenuName() - Method in class io.bretty.console.view.ViewConfig
 
getQuitMessage() - Method in class io.bretty.console.view.ViewConfig
 
getRunningTitle() - Method in class io.bretty.console.view.AbstractView
 
getViewConfig() - Method in class io.bretty.console.view.AbstractView
 
goBack() - Method in class io.bretty.console.view.AbstractView
Try to go back to the parent view.

I

IndexNumberFormatter - Interface in io.bretty.console.view
The interface that format a given index to a string.
io.bretty.console.view - package io.bretty.console.view
 
isValid(T) - Method in interface io.bretty.console.view.Validator
 

K

keyboard - Variable in class io.bretty.console.view.AbstractView
the Scanner to handle user command line input

M

menuItems - Variable in class io.bretty.console.view.MenuView
a list of AbstractView objects to be displayed in the menu as available options
MenuView - Class in io.bretty.console.view
The View that displays a list of options with index numbers, and asks the user to select one to proceed.
MenuView(String, String) - Constructor for class io.bretty.console.view.MenuView
 
MenuView(String, String, ViewConfig) - Constructor for class io.bretty.console.view.MenuView
 

N

nameInParentMenu - Variable in class io.bretty.console.view.AbstractView
the name of this view when displayed in a parent MenuView

O

onBack() - Method in class io.bretty.console.view.AbstractView
Override this method to execute your own logic when the view is going back to the parent view Remember to call "super.onBack()" after your own logic
onQuit() - Method in class io.bretty.console.view.AbstractView
Override this method to execute your own logic when the user is quiting (i.e.

P

parentView - Variable in class io.bretty.console.view.AbstractView
the parent view of the current view if the current view is the root view, this field will always be null
pause() - Method in class io.bretty.console.view.AbstractView
print the default pause message, and the user may press enter to continue.
print(Object) - Method in class io.bretty.console.view.AbstractView
A wrapper of System.out.print(Object o)
println(Object) - Method in class io.bretty.console.view.AbstractView
A wrapper of System.out.println(Object o)
println() - Method in class io.bretty.console.view.AbstractView
A wrapper of System.out.println()
prompt(String, Class<T>) - Method in class io.bretty.console.view.AbstractView
Read an object from command line user input with default type validation.
prompt(String, Class<T>, Validator<T>) - Method in class io.bretty.console.view.AbstractView
Read an object from command line user input with custom validator It will repeatedly ask the user for re-try if validation continues to fail.

R

removeMenuItem(int) - Method in class io.bretty.console.view.MenuView
 
removeMenuItem(AbstractView) - Method in class io.bretty.console.view.MenuView
 
runningTitle - Variable in class io.bretty.console.view.AbstractView
the string always to be displayed in the first line whenever this view is running

S

setActionCanceledMessage(String) - Method in class io.bretty.console.view.ViewConfig.Builder
 
setActionFailedMessage(String) - Method in class io.bretty.console.view.ViewConfig.Builder
 
setActionSuccessfulMessage(String) - Method in class io.bretty.console.view.ViewConfig.Builder
 
setBackMenuName(String) - Method in class io.bretty.console.view.ViewConfig.Builder
 
setConfirm(String, Validator<String>) - Method in class io.bretty.console.view.ViewConfig.Builder
 
setIndexNumberFormatter(IndexNumberFormatter) - Method in class io.bretty.console.view.ViewConfig.Builder
 
setMenuItems(List<AbstractView>) - Method in class io.bretty.console.view.MenuView
 
setMenuSelectionMessage(String) - Method in class io.bretty.console.view.ViewConfig.Builder
 
setNameInParentMenu(String) - Method in class io.bretty.console.view.AbstractView
 
setParentView(AbstractView) - Method in class io.bretty.console.view.AbstractView
 
setPauseMessage(String) - Method in class io.bretty.console.view.ViewConfig.Builder
 
setQuitMenuName(String) - Method in class io.bretty.console.view.ViewConfig.Builder
 
setQuitMessage(String) - Method in class io.bretty.console.view.ViewConfig.Builder
 
setRunningTitle(String) - Method in class io.bretty.console.view.AbstractView
 
setViewConfig(ViewConfig) - Method in class io.bretty.console.view.AbstractView
 

V

Validator<T> - Interface in io.bretty.console.view
The interface that judges if a certain user input is valid.
viewConfig - Variable in class io.bretty.console.view.AbstractView
the configuration of default strings in the UI
ViewConfig - Class in io.bretty.console.view
Configuration of default strings in the UI
ViewConfig.Builder - Class in io.bretty.console.view
A builder class to create custom ViewConfig objects
A B C D E F G I K M N O P R S V 
Skip navigation links

Copyright © 2016. All rights reserved.