Index
All Classes and Interfaces|All Packages|Serialized Form
A
- Array - Class in pretty.utils
-
Utility functions for arrays
- Array() - Constructor for class pretty.utils.Array
B
- back() - Method in class pretty.Router
-
Navigate back to the previous page
- BACKSPACE - Enum constant in enum class pretty.keys.Key
- build() - Static method in class pretty.Terminal
-
Build a terminal with the default key translator
- build(KeyTranslator<K>) - Static method in class pretty.Terminal
-
Build a terminal with a custom key translator
C
- Calc - Class in pretty.utils
-
Math utility functions
- Calc() - Constructor for class pretty.utils.Calc
- cleanup() - Method in class pretty.layout.Menu
-
Rollback all lines and temporary lines
- clear() - Method in class pretty.Terminal
-
Clear the terminal screen
D
- DefaultKeyTranslator - Class in pretty.keys
-
Default key translator, translates virtual key codes to Key values
- DefaultKeyTranslator() - Constructor for class pretty.keys.DefaultKeyTranslator
-
Create an instance of DefaultKeyTranslator
- divider() - Method in class pretty.layout.Menu
-
Push a divider to the menu
- DOWN - Enum constant in enum class pretty.keys.Key
E
- ENTER - Enum constant in enum class pretty.keys.Key
- exists(T[], T) - Static method in class pretty.utils.Array
-
Check if a value exists in an array
F
- format(T) - Method in interface pretty.interfaces.Formatter
-
Format an objects
- Formatter<T,
O> - Interface in pretty.interfaces -
Formatter interface, used to format objects inputs and outputs
G
- getChar(String, Validator<Character>) - Method in class pretty.layout.Menu
-
Get a char from the user
- getChar(String, Validator<Character>, Formatter<Character, String>) - Method in class pretty.layout.Menu
-
Get a char from the user
- getCode() - Method in enum class pretty.keys.Key
-
Get the code of the key.
- getDouble(String, Validator<Double>) - Method in class pretty.layout.Menu
-
Get a double from the user
- getDouble(String, Validator<Double>, Formatter<Double, String>) - Method in class pretty.layout.Menu
-
Get a double from the user
- getFloat(String, Validator<Float>) - Method in class pretty.layout.Menu
-
Get a float from the user
- getFloat(String, Validator<Float>, Formatter<Float, String>) - Method in class pretty.layout.Menu
-
Get a float from the user
- getInstance() - Static method in class pretty.layout.Menu
-
Get the singleton instance of Menu
- getInstance() - Static method in class pretty.Router
-
Get the singleton instance of the router
- getInt(String, Validator<Integer>) - Method in class pretty.layout.Menu
-
Get an integer from the user
- getInt(String, Validator<Integer>, Formatter<Integer, String>) - Method in class pretty.layout.Menu
-
Get an integer from the user
- getLong(String, Validator<Long>) - Method in class pretty.layout.Menu
-
Get an long integer from the user
- getLong(String, Validator<Long>, Formatter<Long, String>) - Method in class pretty.layout.Menu
-
Get an long integer from the user
- getOption(String, String[]) - Method in class pretty.layout.Menu
-
Show options to the user and get the selected option
- getOption(String, String[], int) - Method in class pretty.layout.Menu
-
Show options to the user and get the selected option
- getPageConfirmation() - Method in class pretty.layout.Menu
-
Get a confirmation from the user
- getPageConfirmation(String) - Method in class pretty.layout.Menu
-
Get a confirmation from the user
- getPageOption(String[]) - Method in class pretty.layout.Menu
-
Get an option from the user
- getPageOption(String[], int, int, int, String) - Method in class pretty.layout.Menu
-
Get an option from the user
- getPageOption(String[], Integer[]) - Method in class pretty.layout.Menu
-
Get an option from the user
- getPageOption(String[], Integer[], int, int, String) - Method in class pretty.layout.Menu
-
Get an option from the user
- getPageOption(String[], Integer[], int, String) - Method in class pretty.layout.Menu
-
Get an option from the user
- getPageOption(String[], Integer[], String) - Method in class pretty.layout.Menu
-
Get an option from the user
- getPageOption(String[], String) - Method in class pretty.layout.Menu
-
Get an option from the user
- getString(String, Validator<String>) - Method in class pretty.layout.Menu
-
Get a string from the user
- getString(String, Validator<String>, Formatter<String, String>) - Method in class pretty.layout.Menu
-
Get a string from the user
H
- header(String) - Method in class pretty.layout.Menu
-
Push a header to the menu
- header(String) - Static method in class pretty.layout.Text
-
Returns the message in blue and bold
- highlight(char) - Static method in class pretty.layout.Text
-
Returns the char in blue
- highlight(String) - Static method in class pretty.layout.Text
-
Returns the message in blue
- highlight(T) - Static method in class pretty.layout.Text
-
Returns the number in blue
I
- InvalidInput - Exception Class in pretty.errors
-
Exception to be thrown inside an input Validator
- InvalidInput(String) - Constructor for exception class pretty.errors.InvalidInput
-
Exception to be thrown inside an Validator
K
- key() - Method in class pretty.Terminal
-
Return the next key pressed and translated by KeyTranslator
- Key - Enum Class in pretty.keys
-
Enum representing keys in DefaultKeyTranslator
- KeyTranslator<K> - Interface in pretty.interfaces
-
KeyTranslator interface, used to translate virtual key codes to values
L
- LEFT - Enum constant in enum class pretty.keys.Key
- locked(String) - Static method in class pretty.layout.Text
-
Returns the message in gray
M
- Menu - Class in pretty.layout
-
Used to render menus and get input from the user by terminal
- mod(int, int) - Static method in class pretty.utils.Calc
-
Modulo operation that works with negative numbers
N
- navigate(Page) - Method in class pretty.Router
-
Navigate to a new page
- nextLine(String) - Method in class pretty.Terminal
-
Print a prompt to the terminal and return the next line as Scanner's method
P
- Page - Interface in pretty.interfaces
-
Page interface, pages are passed to the router to be rendered
- phantomPush(String) - Method in class pretty.layout.Menu
-
Push a line to the menu without rendering it
- pretty - package pretty
- pretty.errors - package pretty.errors
- pretty.interfaces - package pretty.interfaces
- pretty.keys - package pretty.keys
- pretty.layout - package pretty.layout
- pretty.utils - package pretty.utils
- push(String) - Method in class pretty.layout.Menu
-
Push a line to the menu
- push(String, boolean) - Method in class pretty.layout.Menu
-
Push a line to the menu
- pushPageBack() - Method in class pretty.layout.Menu
-
Push a footer to the menu with the only option to go back
R
- render(Menu, Router) - Method in interface pretty.interfaces.Page
-
Render the page
- replace(Page) - Method in class pretty.Router
-
Replace the current page with a new page
- RIGHT - Enum constant in enum class pretty.keys.Key
- rollback() - Method in class pretty.layout.Menu
-
Rollback the last line and temporary lines
- rollback(int) - Method in class pretty.layout.Menu
-
Rollback a number of lines, not including temporary lines
- rollbackKeepingTemporary() - Method in class pretty.layout.Menu
-
Rollback the last line, keeping temporary lines
- Router - Class in pretty
-
Manage navigation between pages
- run() - Method in class pretty.ShutdownHook
S
- setTranslator(KeyTranslator<T>) - Method in class pretty.Terminal
-
Set the key translator
- ShutdownHook - Class in pretty
-
Shutdown hook to restore terminal settings
- ShutdownHook(Terminal) - Constructor for class pretty.ShutdownHook
- SPACE - Enum constant in enum class pretty.keys.Key
- start() - Method in class pretty.layout.Menu
-
Start the menu, called by the router by default
- start() - Method in class pretty.Terminal
-
Start the terminal, called by default in Menu
- start(Page) - Method in class pretty.Router
-
Start the router with a page
- success(String) - Static method in class pretty.layout.Text
-
Returns the message in green
T
- temporarilyPush(String) - Method in class pretty.layout.Menu
-
Temporarily push a line to the menu.
- Terminal<T> - Class in pretty
-
Manage terminal input and output
- Text - Class in pretty.layout
-
Text class to format text in the console
- Text() - Constructor for class pretty.layout.Text
- toString() - Method in exception class pretty.errors.InvalidInput
- toString() - Method in enum class pretty.keys.Key
- translate(int) - Method in interface pretty.interfaces.KeyTranslator
-
Translate an virtual key code to a value
- translate(int) - Method in class pretty.keys.DefaultKeyTranslator
-
Translates a virtual key code to a Key value
U
- untranslatable() - Method in interface pretty.interfaces.KeyTranslator
-
Get an untranslatable value
- untranslatable() - Method in class pretty.keys.DefaultKeyTranslator
- untranslatable(int) - Static method in enum class pretty.keys.Key
-
Create an untranslatable key
- UNTRANSLATABLE - Enum constant in enum class pretty.keys.Key
- UP - Enum constant in enum class pretty.keys.Key
V
- validate(T) - Method in interface pretty.interfaces.Validator
-
Validate an object
- Validator<T> - Interface in pretty.interfaces
-
Validator interface, used to validate objects
- valueOf(String) - Static method in enum class pretty.keys.Key
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class pretty.keys.Key
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- warning(String) - Method in class pretty.layout.Menu
-
Rollback the last line and temporary lines and print an warning message
- warning(String) - Static method in class pretty.layout.Text
-
Returns the message in red
- warning(String, int) - Method in class pretty.layout.Menu
-
Rollback a number of lines and temporary lines and print an warning message
All Classes and Interfaces|All Packages|Serialized Form