Index (Vellum)

A B C D E F G H I K L M N O P Q R S T U V W X Y
All Classes All Packages

A

AbstractListSection - Class in com.tonic.vellum.widget: Base for vertical, scrollable, single-selection lists; subclasses supply the row count and row drawing.
AbstractListSection() - Constructor for class com.tonic.vellum.widget.AbstractListSection
active() - Method in class com.tonic.vellum.widget.TabHost
activeFocusTarget() - Method in interface com.tonic.vellum.focus.FocusContainer: Returns the currently focused internal target.
activeFocusTarget() - Method in class com.tonic.vellum.widget.Form
activeFocusTarget() - Method in class com.tonic.vellum.widget.TabHost
add(Constraint, Section) - Method in class com.tonic.vellum.layout.Split: Appends a constrained child.
add(TreeNode) - Method in class com.tonic.vellum.widget.TreeNode: Appends a child node.
add(String, Section) - Method in class com.tonic.vellum.widget.TabHost: Adds a tab with the given title and content.
addField(Section) - Method in class com.tonic.vellum.widget.Form: Adds a focusable field spanning one cell along the form's axis.
addField(Section, int) - Method in class com.tonic.vellum.widget.Form: Adds a focusable field spanning a fixed number of cells along the form's axis.
addField(Section, Constraint) - Method in class com.tonic.vellum.widget.Form: Adds a focusable field sized by an explicit layout constraint.
addRow(String...) - Method in class com.tonic.vellum.widget.Table: Appends a row of cells.
addStatic(Section, int) - Method in class com.tonic.vellum.widget.Form: Adds non-focusable decoration (such as a label) spanning a fixed number of cells.
advanceFocus(boolean) - Method in interface com.tonic.vellum.focus.FocusContainer: Moves internal focus in the given direction.
advanceFocus(boolean) - Method in class com.tonic.vellum.widget.Form
advanceFocus(boolean) - Method in class com.tonic.vellum.widget.TabHost
alert(App, String) - Static method in class com.tonic.vellum.widget.Dialogs: Opens a modal alert showing a message with an OK button; closes on OK or ESC.
alignment(Alignment) - Method in class com.tonic.vellum.widget.LabelSection: Sets the horizontal alignment.
Alignment - Enum in com.tonic.vellum.widget: Horizontal alignment for text widgets.
alt() - Method in class com.tonic.vellum.input.KeyEvent
ansi256(int) - Static method in class com.tonic.vellum.style.Color: Creates a color from a 256-color palette index.
App - Class in com.tonic.vellum: The application engine: owns the terminal, the single UI thread and event loop, layout, repaint, focus, and resize.
App.Builder - Class in com.tonic.vellum: Fluent builder for an App.
append(String) - Method in class com.tonic.vellum.widget.LogSection: Appends a log line.
around(Section) - Static method in class com.tonic.vellum.widget.BorderSection: Wraps a section in a border.
around(Section, String) - Static method in class com.tonic.vellum.widget.BorderSection: Wraps a section in a titled border.
Axis - Enum in com.tonic.vellum.layout: The axis a Split divides along; constraints apply to the main axis, the cross axis gets the full extent.

B

background() - Method in class com.tonic.vellum.style.Style
backgroundSgr() - Method in class com.tonic.vellum.style.Color
BACKSPACE - com.tonic.vellum.input.Key
bg(Color) - Method in class com.tonic.vellum.style.Style: Sets the background color.
BLACK - Static variable in class com.tonic.vellum.style.Color
BLUE - Static variable in class com.tonic.vellum.style.Color
bold(boolean) - Method in class com.tonic.vellum.style.Style: Sets the bold attribute.
BOLD - Static variable in class com.tonic.vellum.style.Style: Bold attribute.
bordered() - Method in class com.tonic.vellum.Section: Wraps this section in a border.
bordered(String) - Method in class com.tonic.vellum.Section: Wraps this section in a titled border.
BorderSection - Class in com.tonic.vellum.widget: A border with an optional title around a single child, insetting the child's bounds by one cell.
BorderSection(Section) - Constructor for class com.tonic.vellum.widget.BorderSection: Creates a border around the given child.
bottom() - Method in class com.tonic.vellum.geom.Rect
bounds() - Method in interface com.tonic.vellum.Canvas
bounds() - Method in class com.tonic.vellum.Section
BRIGHT_BLACK - Static variable in class com.tonic.vellum.style.Color
BRIGHT_BLUE - Static variable in class com.tonic.vellum.style.Color
BRIGHT_CYAN - Static variable in class com.tonic.vellum.style.Color
BRIGHT_GREEN - Static variable in class com.tonic.vellum.style.Color
BRIGHT_MAGENTA - Static variable in class com.tonic.vellum.style.Color
BRIGHT_RED - Static variable in class com.tonic.vellum.style.Color
BRIGHT_WHITE - Static variable in class com.tonic.vellum.style.Color
BRIGHT_YELLOW - Static variable in class com.tonic.vellum.style.Color
build() - Method in class com.tonic.vellum.App.Builder: Builds the configured app.
builder() - Static method in class com.tonic.vellum.App
Builder() - Constructor for class com.tonic.vellum.App.Builder
Button - Class in com.tonic.vellum.widget: A focusable button that runs its action on ENTER or SPACE and is drawn reversed while focused.
Button(String) - Constructor for class com.tonic.vellum.widget.Button: Creates a button with the given label.

C

cancel() - Method in interface com.tonic.vellum.Cancellable: Cancels the scheduled task.
Cancellable - Interface in com.tonic.vellum: Handle for a scheduled task; cancel to stop further runs.
Canvas - Interface in com.tonic.vellum: A drawing surface clipped to a section's bounds.
CENTER - com.tonic.vellum.widget.Alignment
centered(int, int) - Static method in interface com.tonic.vellum.Placement: Creates a placement centered on and clamped to the screen at the given size.
ch() - Method in class com.tonic.vellum.input.KeyEvent
CHAR - com.tonic.vellum.input.Key: A printable character; the character is carried in ch().
character(char) - Static method in class com.tonic.vellum.input.KeyEvent: Creates a printable character event with no modifiers.
character(char, boolean, boolean, boolean) - Static method in class com.tonic.vellum.input.KeyEvent: Creates a printable character event with modifiers.
CharWidth - Class in com.tonic.vellum: Terminal display width of characters and code points: 0 for zero-width, 2 for East Asian wide characters and common emoji, 1 otherwise.
Checkbox - Class in com.tonic.vellum.widget: A focusable on/off toggle, flipped by ENTER or SPACE and drawn reversed while focused.
Checkbox(String) - Constructor for class com.tonic.vellum.widget.Checkbox: Creates an unchecked checkbox with the given label.
checked(boolean) - Method in class com.tonic.vellum.widget.Checkbox: Sets the checked state.
children() - Method in class com.tonic.vellum.widget.TreeNode
choose(int) - Method in class com.tonic.vellum.widget.RadioGroup: Chooses the option at the given index; fires onChange when it changes.
chosenIndex() - Method in class com.tonic.vellum.widget.RadioGroup
clamp(double, double, double) - Static method in class com.tonic.vellum.Maths: Constrains value to the inclusive range [min, max].
clamp(int, int, int) - Static method in class com.tonic.vellum.Maths: Constrains value to the inclusive range [min, max].
clear() - Method in interface com.tonic.vellum.Canvas: Fills the entire canvas with spaces in the default style.
clip(Rect) - Method in interface com.tonic.vellum.Canvas: Returns a further-clipped sub-canvas whose origin is the given rectangle's top-left.
close() - Method in interface com.tonic.vellum.OverlayHandle: Removes the overlay and pops its focus scope.
close() - Method in interface com.tonic.vellum.terminal.Terminal
code() - Method in class com.tonic.vellum.input.KeyEvent
Color - Class in com.tonic.vellum.style: An immutable terminal color: the terminal default, a named ANSI color, a 256-color palette index, or 24-bit RGB.
column(String, Constraint) - Method in class com.tonic.vellum.widget.Table: Adds a left-aligned column.
column(String, Constraint, Alignment) - Method in class com.tonic.vellum.widget.Table: Adds a column with the given alignment.
columns() - Method in class com.tonic.vellum.terminal.TerminalSize
com.tonic.vellum - package com.tonic.vellum
com.tonic.vellum.focus - package com.tonic.vellum.focus
com.tonic.vellum.geom - package com.tonic.vellum.geom
com.tonic.vellum.input - package com.tonic.vellum.input
com.tonic.vellum.layout - package com.tonic.vellum.layout
com.tonic.vellum.style - package com.tonic.vellum.style
com.tonic.vellum.terminal - package com.tonic.vellum.terminal
com.tonic.vellum.widget - package com.tonic.vellum.widget
confirm(App, String, Runnable) - Static method in class com.tonic.vellum.widget.Dialogs: Opens a modal confirmation with Yes and No buttons; Yes runs the callback then closes, No or ESC just close.
constraint() - Method in class com.tonic.vellum.layout.Slot
Constraint - Class in com.tonic.vellum.layout: An immutable sizing rule for one child of a Split, created via the static factory methods.
Constraint.Kind - Enum in com.tonic.vellum.layout: The category of a constraint.
CONSUMED - com.tonic.vellum.KeyResult: The key was handled; propagation stops.
contains(int, int) - Method in class com.tonic.vellum.geom.Rect
count() - Method in class com.tonic.vellum.widget.TabHost
ctrl() - Method in class com.tonic.vellum.input.KeyEvent
CTRL_TAB - com.tonic.vellum.input.Key: Ctrl+Tab; recognized only where the terminal reports it.
current() - Static method in class com.tonic.vellum.App
CYAN - Static variable in class com.tonic.vellum.style.Color

D

DEFAULT - Static variable in class com.tonic.vellum.style.Color: The terminal's default color.
DEFAULT_MAX_LINES - Static variable in class com.tonic.vellum.widget.LogSection: Default retained line cap, to bound memory for long-running logs.
DELETE - com.tonic.vellum.input.Key
Dialogs - Class in com.tonic.vellum.widget: Static helpers that open modal dialogs as centered, bordered Form overlays; all methods must be called on the UI thread.
dim(boolean) - Method in class com.tonic.vellum.style.Style: Sets the dim attribute.
DIM - Static variable in class com.tonic.vellum.style.Style: Dim attribute.
DIM_REVERSE - Static variable in class com.tonic.vellum.style.Style: Dimmed inverse.
DOWN - com.tonic.vellum.input.Key

E

emptyStyle(Style) - Method in class com.tonic.vellum.widget.ProgressBar: Sets the style of the empty portion.
END - com.tonic.vellum.input.Key
ENTER - com.tonic.vellum.input.Key
enterAlternateScreen() - Method in interface com.tonic.vellum.terminal.Terminal: Switches to the alternate screen buffer so the user's scrollback is preserved.
enterRawMode() - Method in interface com.tonic.vellum.terminal.Terminal: Switches the terminal into raw (unbuffered, no-echo) mode.
equals(Object) - Method in class com.tonic.vellum.geom.Point
equals(Object) - Method in class com.tonic.vellum.geom.Rect
equals(Object) - Method in class com.tonic.vellum.layout.Constraint
equals(Object) - Method in class com.tonic.vellum.style.Color
equals(Object) - Method in class com.tonic.vellum.style.Style
equals(Object) - Method in class com.tonic.vellum.terminal.TerminalSize
ESCAPE - com.tonic.vellum.input.Key
expanded(boolean) - Method in class com.tonic.vellum.widget.TreeNode: Sets whether this node is expanded.

F

fg(Color) - Method in class com.tonic.vellum.style.Style: Sets the foreground color.
fill() - Static method in class com.tonic.vellum.layout.Constraint
fill(int) - Static method in class com.tonic.vellum.layout.Constraint: Creates a constraint taking a weighted share of the remaining space.
fill(Rect, char, Style) - Method in interface com.tonic.vellum.Canvas: Fills a local rectangle with a character and style.
FILL - com.tonic.vellum.layout.Constraint.Kind
filledStyle(Style) - Method in class com.tonic.vellum.widget.ProgressBar: Sets the style of the filled portion.
fixed(int) - Static method in class com.tonic.vellum.layout.Constraint: Creates a fixed-size constraint of exactly cells along the main axis.
fixed(Rect) - Static method in interface com.tonic.vellum.Placement: Creates a placement at a fixed rectangle, independent of screen size.
FIXED - com.tonic.vellum.layout.Constraint.Kind
flush() - Method in interface com.tonic.vellum.terminal.Terminal: Flushes queued output to the terminal.
FocusContainer - Interface in com.tonic.vellum.focus: Capability for a Section that manages internal focus stops; the focus manager consults it before advancing at the parent level.
focusedStyle() - Method in class com.tonic.vellum.widget.BorderSection
focusedStyle(Style) - Method in class com.tonic.vellum.widget.BorderSection: Sets the frame style used when the child is on the focus path.
focusedStyle(Style) - Method in class com.tonic.vellum.widget.Button: Sets the style used when the button is focused.
focusOrder(Section...) - Method in class com.tonic.vellum.App.Builder: Sets the sections that participate in focus navigation, in order.
focusTargets() - Method in interface com.tonic.vellum.focus.FocusContainer: Returns the focusable descendants this container manages internally.
focusTargets() - Method in class com.tonic.vellum.widget.Form
focusTargets() - Method in class com.tonic.vellum.widget.TabHost
followTail(boolean) - Method in class com.tonic.vellum.widget.ScrollSection: Sets whether the view stays pinned to the bottom as lines are appended.
foreground() - Method in class com.tonic.vellum.style.Style
foregroundSgr() - Method in class com.tonic.vellum.style.Color
Form - Class in com.tonic.vellum.widget: A stack of fields with internal Tab traversal: Tab and Shift-Tab cycle the fields, descending depth-first into nested forms.
Form() - Constructor for class com.tonic.vellum.widget.Form: Creates a vertical form whose fields are stacked top to bottom.

G

GREEN - Static variable in class com.tonic.vellum.style.Color

H

hashCode() - Method in class com.tonic.vellum.geom.Point
hashCode() - Method in class com.tonic.vellum.geom.Rect
hashCode() - Method in class com.tonic.vellum.layout.Constraint
hashCode() - Method in class com.tonic.vellum.style.Color
hashCode() - Method in class com.tonic.vellum.style.Style
hashCode() - Method in class com.tonic.vellum.terminal.TerminalSize
headerStyle(Style) - Method in class com.tonic.vellum.widget.Table: Sets the style used to draw the header row.
height() - Method in interface com.tonic.vellum.Canvas
height() - Method in class com.tonic.vellum.geom.Rect
hideCursor() - Method in interface com.tonic.vellum.terminal.Terminal: Hides the cursor.
HOME - com.tonic.vellum.input.Key
horizontal(Slot...) - Static method in class com.tonic.vellum.layout.Split: Creates a horizontal split from the given slots.
HORIZONTAL - com.tonic.vellum.layout.Axis

I

initialFocus(Section) - Method in class com.tonic.vellum.App.Builder: Sets the section that holds focus when the app starts.
inset(int) - Method in class com.tonic.vellum.geom.Rect: Shrinks this rect on all four sides.
intersect(Rect) - Method in class com.tonic.vellum.geom.Rect: Returns the overlap of this rect and other; the result is empty (zero width or height) when they do not overlap.
is(Key) - Method in class com.tonic.vellum.input.KeyEvent
isBold() - Method in class com.tonic.vellum.style.Style
isCancelled() - Method in interface com.tonic.vellum.Cancellable
isChecked() - Method in class com.tonic.vellum.widget.Checkbox
isDim() - Method in class com.tonic.vellum.style.Style
isEmpty() - Method in class com.tonic.vellum.geom.Rect
isExpanded() - Method in class com.tonic.vellum.widget.TreeNode
isFocused() - Method in class com.tonic.vellum.Section
isLeaf() - Method in class com.tonic.vellum.widget.TreeNode
isOpen() - Method in interface com.tonic.vellum.OverlayHandle
isReverse() - Method in class com.tonic.vellum.style.Style
isUnderline() - Method in class com.tonic.vellum.style.Style

K

Key - Enum in com.tonic.vellum.input: Logical key identity.
KeyEvent - Class in com.tonic.vellum.input: An immutable, normalized key event.
KeyEvent(Key, char, boolean, boolean, boolean) - Constructor for class com.tonic.vellum.input.KeyEvent: Creates a key event.
KeyResult - Enum in com.tonic.vellum: Outcome of Section.onKey: whether the key was handled or should keep propagating.
kind() - Method in class com.tonic.vellum.layout.Constraint

L

label() - Method in class com.tonic.vellum.widget.TreeNode
label(String) - Method in class com.tonic.vellum.widget.Spinner: Sets the label shown next to the spinner.
LabelSection - Class in com.tonic.vellum.widget: A single line of static or settable text, with optional horizontal alignment.
LabelSection(String) - Constructor for class com.tonic.vellum.widget.LabelSection: Creates a label with the given text.
LayoutSolver - Class in com.tonic.vellum.layout: A constraint solver that divides a rect among children along one axis, always tiling the extent exactly: any rounding remainder goes to the last flexible item, or stretches the last item if none is flexible.
LEFT - com.tonic.vellum.input.Key
LEFT - com.tonic.vellum.widget.Alignment
lineCount() - Method in class com.tonic.vellum.widget.ScrollSection
LogSection - Class in com.tonic.vellum.widget: A ScrollSection for logs: follows the tail by default and retains a bounded number of lines, dropping the oldest.
LogSection() - Constructor for class com.tonic.vellum.widget.LogSection: Creates a log section that follows the tail and retains DEFAULT_MAX_LINES lines.

M

MAGENTA - Static variable in class com.tonic.vellum.style.Color
Maths - Class in com.tonic.vellum: Small numeric helpers.
max(int) - Static method in class com.tonic.vellum.layout.Constraint: Creates a constraint of at most cells, growing into remaining space up to that cap.
MAX - com.tonic.vellum.layout.Constraint.Kind
maxLines(int) - Method in class com.tonic.vellum.widget.ScrollSection: Caps the retained lines, dropping the oldest beyond max; 0 means unlimited.
MenuSection - Class in com.tonic.vellum.widget: A vertical, arrow-navigable, scrollable list of strings with a selection; ENTER fires onSelect.
MenuSection(String...) - Constructor for class com.tonic.vellum.widget.MenuSection: Creates a menu with the given items.
min(int) - Static method in class com.tonic.vellum.layout.Constraint: Creates a constraint of at least cells, growing into remaining space.
MIN - com.tonic.vellum.layout.Constraint.Kind
moveCursor(int, int) - Method in interface com.tonic.vellum.terminal.Terminal: Positions the cursor at a zero-based cell coordinate.

N

navigation(Navigation) - Method in class com.tonic.vellum.App.Builder: Sets the navigation strategy that moves focus between targets.
Navigation - Interface in com.tonic.vellum.focus: Strategy that moves focus to an adjacent target when the focused section leaves an arrow key unhandled.
NORMAL - Static variable in class com.tonic.vellum.style.Style: Default foreground and background with no attributes.

O

of(char) - Static method in class com.tonic.vellum.CharWidth: Returns the display width of a BMP character.
of(int) - Static method in class com.tonic.vellum.CharWidth: Returns the display width of a Unicode code point.
of(Constraint, Section) - Static method in class com.tonic.vellum.layout.Slot: Pairs a constraint with the section it sizes.
onActivate(Runnable) - Method in class com.tonic.vellum.widget.Button: Sets the action run when the button is activated.
onCancel(Runnable) - Method in class com.tonic.vellum.widget.Form: Sets the handler run when ESC is pressed while the form has focus.
onChange(Consumer<Boolean>) - Method in class com.tonic.vellum.widget.Checkbox: Sets the handler invoked with the new state whenever the checkbox is toggled.
onChange(Consumer<String>) - Method in class com.tonic.vellum.widget.TextInput: Sets the handler called with the current text after every edit.
onChange(IntConsumer) - Method in class com.tonic.vellum.widget.RadioGroup: Sets the handler called with the chosen index whenever the choice changes.
onError(Consumer<Throwable>) - Method in class com.tonic.vellum.App.Builder: Sets a handler for exceptions thrown by a task, key handler, or section render, invoked on the UI thread.
onHighlight(IntConsumer) - Method in class com.tonic.vellum.widget.AbstractListSection: Sets the handler called with the row index whenever the selection moves.
onQuit(Predicate<KeyEvent>) - Method in class com.tonic.vellum.App.Builder: Quits when a key matches the predicate.
onQuitKey(char) - Method in class com.tonic.vellum.App.Builder: Quits on a specific printable character.
onQuitKey(Key) - Method in class com.tonic.vellum.App.Builder: Quits on a specific logical key.
onSelect(IntConsumer) - Method in class com.tonic.vellum.widget.AbstractListSection: Sets the handler called with the row index on ENTER.
onSelect(IntConsumer) - Method in class com.tonic.vellum.widget.MenuSection
onSelect(IntConsumer) - Method in class com.tonic.vellum.widget.SelectList
onSelectItem(Consumer<T>) - Method in class com.tonic.vellum.widget.SelectList: Sets the handler called with the item on ENTER.
onSelectNode(Consumer<TreeNode>) - Method in class com.tonic.vellum.widget.TreeView: Sets the handler invoked with a leaf node when it is activated.
onSubmit(Consumer<String>) - Method in class com.tonic.vellum.widget.TextInput: Sets the handler called with the current text when Enter is pressed.
openOverlay(Section, Placement, Section...) - Method in class com.tonic.vellum.App: Opens a modal overlay rendered on top of the UI and routes keys to it.
OverlayHandle - Interface in com.tonic.vellum: Handle to an open overlay.

P

PAGE_DOWN - com.tonic.vellum.input.Key
PAGE_UP - com.tonic.vellum.input.Key
parent() - Method in class com.tonic.vellum.Section
percent(int) - Static method in class com.tonic.vellum.layout.Constraint: Creates a constraint sized as a percentage of the original available extent.
PERCENT - com.tonic.vellum.layout.Constraint.Kind
placeholder(String) - Method in class com.tonic.vellum.widget.TextInput: Sets the placeholder shown when the field is empty and unfocused.
placeholderStyle(Style) - Method in class com.tonic.vellum.widget.TextInput: Sets the style used to draw the placeholder.
Placement - Interface in com.tonic.vellum: Computes an overlay's bounds from the current screen bounds.
Point - Class in com.tonic.vellum.geom: An immutable point in cell coordinates.
Point(int, int) - Constructor for class com.tonic.vellum.geom.Point: Creates a point.
post(Runnable) - Method in class com.tonic.vellum.App: Marshals a runnable onto the UI thread.
progress(int, int) - Method in class com.tonic.vellum.widget.ProgressBar: Sets progress as a ratio of current to max; a non-positive max yields zero progress.
ProgressBar - Class in com.tonic.vellum.widget: A horizontal progress bar over the range 0 to 1, drawn with block glyphs and an optional centered percentage.
ProgressBar() - Constructor for class com.tonic.vellum.widget.ProgressBar
prompt(App, String, Consumer<String>) - Static method in class com.tonic.vellum.widget.Dialogs: Opens a modal prompt with a title, a text field, and OK and Cancel buttons; OK or Enter in the field submits the entered text then closes, Cancel or ESC just close.
put(int, int, char) - Method in interface com.tonic.vellum.Canvas: Writes a character with the default style.
put(int, int, char, Style) - Method in interface com.tonic.vellum.Canvas: Writes a character with an explicit style.
put(int, int, String) - Method in interface com.tonic.vellum.Canvas: Writes a single line of text with the default style, truncated at the right edge.
put(int, int, String, Style) - Method in interface com.tonic.vellum.Canvas: Writes a single line of text, truncated at the right edge.
putCodePoint(int, int, int) - Method in interface com.tonic.vellum.Canvas: Writes a Unicode code point, including supplementary characters, with the default style.
putCodePoint(int, int, int, Style) - Method in interface com.tonic.vellum.Canvas: Writes a Unicode code point, including supplementary characters, with an explicit style.

Q

quit() - Method in class com.tonic.vellum.App: Stops the event loop; run() then restores the terminal.

R

RadioGroup - Class in com.tonic.vellum.widget: A single-choice option list; ENTER or SPACE chooses the option under the cursor, marked (o).
RadioGroup(String...) - Constructor for class com.tonic.vellum.widget.RadioGroup: Creates a radio group with the given options.
readKey(long) - Method in interface com.tonic.vellum.terminal.Terminal: Reads and decodes the next key, blocking up to timeoutMillis.
Rect - Class in com.tonic.vellum.geom: An immutable rectangle in cell coordinates.
Rect(int, int, int, int) - Constructor for class com.tonic.vellum.geom.Rect: Creates a rectangle.
RED - Static variable in class com.tonic.vellum.style.Color
refresh() - Method in class com.tonic.vellum.widget.TreeView: Re-flattens the visible rows after the tree is mutated outside the view.
renderer(Function<T, String>) - Method in class com.tonic.vellum.widget.SelectList: Sets the function that renders each item to a display string.
requestRedraw() - Method in class com.tonic.vellum.Section: Marks this section dirty; the framework batches and repaints the dirty subtree.
resolve(Rect) - Method in interface com.tonic.vellum.Placement: Resolves the overlay bounds for the given screen bounds.
resolve(Section, Key, List<Section>) - Method in interface com.tonic.vellum.focus.Navigation: Chooses the focus target reached by moving in the given direction from the current section.
restore() - Method in interface com.tonic.vellum.terminal.Terminal: Restores the terminal to the main screen, cooked mode, and shown cursor.
reverse(boolean) - Method in class com.tonic.vellum.style.Style: Sets the reverse attribute.
REVERSE - Static variable in class com.tonic.vellum.style.Style: Inverted foreground and background.
rgb(int, int, int) - Static method in class com.tonic.vellum.style.Color: Creates a 24-bit truecolor.
right() - Method in class com.tonic.vellum.geom.Rect
RIGHT - com.tonic.vellum.input.Key
RIGHT - com.tonic.vellum.widget.Alignment
root(Section) - Method in class com.tonic.vellum.App.Builder: Sets the root section of the UI.
row() - Static method in class com.tonic.vellum.widget.Form
rows() - Method in class com.tonic.vellum.terminal.TerminalSize
run() - Method in class com.tonic.vellum.App: Installs the terminal, runs the event loop until quit, and restores the terminal on exit, even if an exception propagates.

S

schedule(Duration, Runnable) - Method in class com.tonic.vellum.App: Schedules a one-shot task on the UI thread.
scheduleAtFixedRate(Duration, Duration, Runnable) - Method in class com.tonic.vellum.App: Schedules a repeating task on the UI thread.
ScrollSection - Class in com.tonic.vellum.widget: Vertically scrollable lines of text, scrolled with UP/DOWN/PAGE_UP/PAGE_DOWN/HOME/END.
ScrollSection() - Constructor for class com.tonic.vellum.widget.ScrollSection
scrollTop() - Method in class com.tonic.vellum.widget.ScrollSection
section() - Method in class com.tonic.vellum.layout.Slot
Section - Class in com.tonic.vellum: The base unit of a Vellum UI: every visible element is a Section, and containers are Sections that hold other Sections.
Section() - Constructor for class com.tonic.vellum.Section
select(int) - Method in class com.tonic.vellum.widget.AbstractListSection: Moves the selection to the given index (clamped to the valid range); fires onHighlight when it changes.
select(int) - Method in class com.tonic.vellum.widget.TabHost: Switches to the tab at the given index, firing the visibility lifecycle on the outgoing and incoming children.
select(String) - Method in class com.tonic.vellum.widget.TabHost: Switches to the tab with the given title.
selectedIndex() - Method in class com.tonic.vellum.widget.AbstractListSection
selectedItem() - Method in class com.tonic.vellum.widget.SelectList
selectedNode() - Method in class com.tonic.vellum.widget.TreeView
selectedRow() - Method in class com.tonic.vellum.widget.Table
SelectList<T> - Class in com.tonic.vellum.widget: A scrollable, selectable list of typed items, each rendered to a display string; ENTER fires the selection handlers.
SelectList() - Constructor for class com.tonic.vellum.widget.SelectList: Creates an empty list.
SelectList(List<T>) - Constructor for class com.tonic.vellum.widget.SelectList: Creates a list populated with the given items.
setItems(List<T>) - Method in class com.tonic.vellum.widget.SelectList: Replaces the items with the given list.
setLabel(String) - Method in class com.tonic.vellum.widget.Button: Sets the button's label.
setLines(List<String>) - Method in class com.tonic.vellum.widget.ScrollSection: Replaces all lines; scrolls to the bottom when following the tail.
setResizeListener(Runnable) - Method in interface com.tonic.vellum.terminal.Terminal: Registers a callback invoked when the terminal resizes.
setRows(List<String[]>) - Method in class com.tonic.vellum.widget.Table: Replaces all rows.
setText(String) - Method in class com.tonic.vellum.widget.LabelSection: Sets the label text.
setText(String) - Method in class com.tonic.vellum.widget.StatusBar: Sets the bar text.
setText(String) - Method in class com.tonic.vellum.widget.TextInput: Sets the field text, moving the caret to the end.
setText(String) - Method in class com.tonic.vellum.widget.TextSection: Sets the text.
setValues(double[]) - Method in class com.tonic.vellum.widget.Sparkline: Sets the value series from an array.
setValues(List<? extends Number>) - Method in class com.tonic.vellum.widget.Sparkline: Sets the value series from a list of numbers.
shift() - Method in class com.tonic.vellum.input.KeyEvent
SHIFT_TAB - com.tonic.vellum.input.Key
showCursor() - Method in interface com.tonic.vellum.terminal.Terminal: Shows the cursor.
showHeader(boolean) - Method in class com.tonic.vellum.widget.Table: Sets whether the header row is shown.
showPercent(boolean) - Method in class com.tonic.vellum.widget.ProgressBar: Sets whether the centered percentage is shown.
showTabBar(boolean) - Method in class com.tonic.vellum.widget.TabHost: Sets whether the tab bar is shown.
SingleRowSection - Class in com.tonic.vellum.widget: Base for leaf widgets that draw a single, vertically centered row; subclasses implement renderRow.
SingleRowSection() - Constructor for class com.tonic.vellum.widget.SingleRowSection
size() - Method in interface com.tonic.vellum.terminal.Terminal
Slot - Class in com.tonic.vellum.layout: A typed (constraint, section) pair for the varargs Split constructors.
solve(Rect, List<Constraint>, Axis) - Static method in class com.tonic.vellum.layout.LayoutSolver: Divides the available rect among the constraints along the given axis.
Sparkline - Class in com.tonic.vellum.widget: A one-row chart of a value series drawn with partial block glyphs, auto-scaled to the series range; newest values are on the right.
Sparkline() - Constructor for class com.tonic.vellum.widget.Sparkline
spatial() - Static method in interface com.tonic.vellum.focus.Navigation
special(Key) - Static method in class com.tonic.vellum.input.KeyEvent: Creates a non-printable key event with no modifiers.
special(Key, boolean, boolean, boolean) - Static method in class com.tonic.vellum.input.KeyEvent: Creates a non-printable key event with modifiers.
Spinner - Class in com.tonic.vellum.widget: An indeterminate progress indicator that cycles frames; advance with tick() or animate on a timer with start(App).
Spinner() - Constructor for class com.tonic.vellum.widget.Spinner
Split - Class in com.tonic.vellum.layout: A section that divides its bounds among child sections along one axis according to their constraints.
splitBottom(int) - Method in class com.tonic.vellum.geom.Rect: Splits off a bottom strip.
splitLeft(int) - Method in class com.tonic.vellum.geom.Rect: Splits off a left strip.
splitRight(int) - Method in class com.tonic.vellum.geom.Rect: Splits off a right strip.
splitTop(int) - Method in class com.tonic.vellum.geom.Rect: Splits off a top strip.
start(App) - Method in class com.tonic.vellum.widget.Spinner: Animates the spinner on the app timer until the returned handle is cancelled.
StatusBar - Class in com.tonic.vellum.widget: A single-row text bar, reverse-video by default, for hints and status.
StatusBar(String) - Constructor for class com.tonic.vellum.widget.StatusBar: Creates a status bar with the given text.
style(Style) - Method in class com.tonic.vellum.widget.Button: Sets the style used when the button is not focused.
style(Style) - Method in class com.tonic.vellum.widget.LabelSection: Sets the text style.
style(Style) - Method in class com.tonic.vellum.widget.ScrollSection: Sets the text style.
style(Style) - Method in class com.tonic.vellum.widget.Sparkline: Sets the style used to draw the chart.
style(Style) - Method in class com.tonic.vellum.widget.Spinner: Sets the style used to draw the spinner and label.
style(Style) - Method in class com.tonic.vellum.widget.StatusBar: Sets the bar style.
style(Style) - Method in class com.tonic.vellum.widget.TextInput: Sets the style used to draw the text.
style(Style) - Method in class com.tonic.vellum.widget.TextSection: Sets the text style.
Style - Class in com.tonic.vellum.style: An immutable text styling value; setters return new instances and instances compare by value.
system() - Static method in class com.tonic.vellum.terminal.Terminals: Opens the system terminal, JLine-backed by default.

T

TAB - com.tonic.vellum.input.Key
TabHost - Class in com.tonic.vellum.widget: A tab container that renders the active tab's content plus a one-row tab bar.
TabHost() - Constructor for class com.tonic.vellum.widget.TabHost
Table - Class in com.tonic.vellum.widget: A scrollable table with a fixed header and selectable rows; column widths are solved from each column's Constraint, so the header and rows always align and tile the width.
Table() - Constructor for class com.tonic.vellum.widget.Table
takeBottom(int) - Method in class com.tonic.vellum.geom.Rect: Returns the bottom strip of the given height, clamped to this rect.
takeLeft(int) - Method in class com.tonic.vellum.geom.Rect: Returns the left strip of the given width, clamped to this rect.
takeRight(int) - Method in class com.tonic.vellum.geom.Rect: Returns the right strip of the given width, clamped to this rect.
takeTop(int) - Method in class com.tonic.vellum.geom.Rect: Returns the top strip of the given height, clamped to this rect.
Terminal - Interface in com.tonic.vellum.terminal: The terminal driver contract.
Terminals - Class in com.tonic.vellum.terminal: Factory for the platform terminal driver.
TerminalSize - Class in com.tonic.vellum.terminal: Immutable terminal dimensions in character cells.
TerminalSize(int, int) - Constructor for class com.tonic.vellum.terminal.TerminalSize: Creates a terminal size.
text() - Method in class com.tonic.vellum.widget.LabelSection
text() - Method in class com.tonic.vellum.widget.TextInput
TextInput - Class in com.tonic.vellum.widget: A single-line editable text field with caret movement and horizontal scrolling.
TextInput() - Constructor for class com.tonic.vellum.widget.TextInput: Creates an empty field.
TextInput(String) - Constructor for class com.tonic.vellum.widget.TextInput: Creates a field initialized with the given text.
TextSection - Class in com.tonic.vellum.widget: Multi-line static or settable text, drawn top-down.
TextSection(String) - Constructor for class com.tonic.vellum.widget.TextSection: Creates a text section.
tick() - Method in class com.tonic.vellum.widget.Spinner: Advances to the next animation frame.
title(String) - Method in class com.tonic.vellum.widget.BorderSection: Sets the border title drawn into the top edge.
toString() - Method in class com.tonic.vellum.geom.Point
toString() - Method in class com.tonic.vellum.geom.Rect
toString() - Method in class com.tonic.vellum.input.KeyEvent
toString() - Method in class com.tonic.vellum.layout.Constraint
toString() - Method in class com.tonic.vellum.style.Color
toString() - Method in class com.tonic.vellum.style.Style
toString() - Method in class com.tonic.vellum.terminal.TerminalSize
TreeNode - Class in com.tonic.vellum.widget: A node in a TreeView: a label, ordered children, and an expanded flag.
TreeNode(String) - Constructor for class com.tonic.vellum.widget.TreeNode: Creates a leaf node with the given label.
TreeView - Class in com.tonic.vellum.widget: A scrollable tree view that flattens the expanded nodes to rows; activation toggles a parent or selects a leaf, and LEFT/RIGHT collapse and expand the node under the cursor.
TreeView(TreeNode) - Constructor for class com.tonic.vellum.widget.TreeView: Creates a tree view showing the root node.
TreeView(TreeNode, boolean) - Constructor for class com.tonic.vellum.widget.TreeView: Creates a tree view, optionally hiding the root node.

U

underline(boolean) - Method in class com.tonic.vellum.style.Style: Sets the underline attribute.
UNDERLINE - Static variable in class com.tonic.vellum.style.Style: Underline attribute.
unfocusedStyle() - Method in class com.tonic.vellum.widget.BorderSection
unfocusedStyle(Style) - Method in class com.tonic.vellum.widget.BorderSection: Sets the frame style used when the child is not on the focus path.
UNHANDLED - com.tonic.vellum.KeyResult: The key was not handled; it bubbles to the parent chain and the focus manager.
UNKNOWN - com.tonic.vellum.input.Key: An unrecognized input sequence.
UP - com.tonic.vellum.input.Key

V

value() - Method in class com.tonic.vellum.layout.Constraint
value() - Method in class com.tonic.vellum.widget.ProgressBar
value(double) - Method in class com.tonic.vellum.widget.ProgressBar: Sets progress as a fraction, clamped to the range [0, 1].
valueOf(String) - Static method in enum com.tonic.vellum.input.Key: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.tonic.vellum.KeyResult: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.tonic.vellum.layout.Axis: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.tonic.vellum.layout.Constraint.Kind: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.tonic.vellum.widget.Alignment: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.tonic.vellum.input.Key: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.tonic.vellum.KeyResult: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.tonic.vellum.layout.Axis: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.tonic.vellum.layout.Constraint.Kind: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.tonic.vellum.widget.Alignment: Returns an array containing the constants of this enum type, in the order they are declared.
vertical(Slot...) - Static method in class com.tonic.vellum.layout.Split: Creates a vertical split from the given slots.
VERTICAL - com.tonic.vellum.layout.Axis

W

WHITE - Static variable in class com.tonic.vellum.style.Color
width() - Method in interface com.tonic.vellum.Canvas
width() - Method in class com.tonic.vellum.geom.Rect
width(CharSequence) - Static method in class com.tonic.vellum.CharWidth: Returns the total display width of a sequence (sum of its code points' widths).
wrap(boolean) - Method in class com.tonic.vellum.widget.ScrollSection: Enables width-aware word wrapping; scrolling then operates over wrapped display lines.
wrap(boolean) - Method in class com.tonic.vellum.widget.TextSection: Enables width-aware word wrapping (default off).
write(String) - Method in interface com.tonic.vellum.terminal.Terminal: Queues an already-formed ANSI string for output.

X

x() - Method in class com.tonic.vellum.geom.Point
x() - Method in class com.tonic.vellum.geom.Rect

Y

y() - Method in class com.tonic.vellum.geom.Point
y() - Method in class com.tonic.vellum.geom.Rect
YELLOW - Static variable in class com.tonic.vellum.style.Color

A B C D E F G H I K L M N O P Q R S T U V W X Y
All Classes All Packages