Package org.springframework.shell.jline.tui.component

Class NumberInput

java.lang.Object

org.springframework.shell.jline.tui.component.support.AbstractComponent<C>

org.springframework.shell.jline.tui.component.support.AbstractTextComponent<Number,NumberInput.NumberInputContext>

org.springframework.shell.jline.tui.component.NumberInput

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ResourceLoaderAware

public class NumberInput
extends AbstractTextComponent<Number,NumberInput.NumberInputContext>

Component for a number input.

Author:

Nicola Di Falco

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NumberInput.NumberInputContext

Nested classes/interfaces inherited from class org.springframework.shell.jline.tui.component.support.AbstractTextComponent

AbstractTextComponent.BaseTextComponentContext<T,C extends AbstractTextComponent.TextComponentContext<T,C>>, AbstractTextComponent.TextComponentContext<T,C extends AbstractTextComponent.TextComponentContext<T,C>>

Field Summary

Fields inherited from class org.springframework.shell.jline.tui.component.support.AbstractComponent

OPERATION_BACKSPACE, OPERATION_CHAR, OPERATION_DOWN, OPERATION_EXIT, OPERATION_SELECT, OPERATION_UNICODE, OPERATION_UP

Constructor Summary

Constructors

Constructor	Description
NumberInput(org.jline.terminal.Terminal terminal)
NumberInput(org.jline.terminal.Terminal terminal, @Nullable String name)
NumberInput(org.jline.terminal.Terminal terminal, @Nullable String name, @Nullable Number defaultValue)
NumberInput(org.jline.terminal.Terminal terminal, @Nullable String name, @Nullable Number defaultValue, Class<? extends Number> clazz)
NumberInput(org.jline.terminal.Terminal terminal, @Nullable String name, @Nullable Number defaultValue, Class<? extends Number> clazz, boolean required)
NumberInput(org.jline.terminal.Terminal terminal, @Nullable String name, @Nullable Number defaultValue, Class<? extends Number> clazz, boolean required, @Nullable Function<NumberInput.NumberInputContext,List<org.jline.utils.AttributedString>> renderer)

Method Summary

Modifier and Type	Method	Description
NumberInput.NumberInputContext	getThisContext(@Nullable ComponentContext<?> context)	Gets a real component context using common this trick.
protected boolean	read(org.jline.keymap.BindingReader bindingReader, org.jline.keymap.KeyMap<String> keyMap, NumberInput.NumberInputContext context)	Read input.
void	setNumberClass(Class<? extends Number> clazz)
void	setRequired(boolean required)

Methods inherited from class org.springframework.shell.jline.tui.component.support.AbstractTextComponent

bindKeyMap, getName, runInternal

Methods inherited from class org.springframework.shell.jline.tui.component.support.AbstractComponent

addPostRunHandler, addPreRunHandler, getTemplateExecutor, getTerminal, hasTty, loop, render, renderTemplateResource, run, runPostRunHandlers, runPreRunHandlers, setPrintResults, setRenderer, setResourceLoader, setTemplateExecutor, setTemplateLocation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NumberInput

public NumberInput(org.jline.terminal.Terminal terminal)

NumberInput

public NumberInput(org.jline.terminal.Terminal terminal,
 @Nullable String name)

NumberInput

public NumberInput(org.jline.terminal.Terminal terminal,
 @Nullable String name,
 @Nullable Number defaultValue)

NumberInput

public NumberInput(org.jline.terminal.Terminal terminal,
 @Nullable String name,
 @Nullable Number defaultValue,
 Class<? extends Number> clazz)

NumberInput

public NumberInput(org.jline.terminal.Terminal terminal,
 @Nullable String name,
 @Nullable Number defaultValue,
 Class<? extends Number> clazz,
 boolean required)

NumberInput

public NumberInput(org.jline.terminal.Terminal terminal,
 @Nullable String name,
 @Nullable Number defaultValue,
 Class<? extends Number> clazz,
 boolean required,
 @Nullable Function<NumberInput.NumberInputContext,List<org.jline.utils.AttributedString>> renderer)

Method Details

setNumberClass

public void setNumberClass(Class<? extends Number> clazz)

setRequired

public void setRequired(boolean required)

getThisContext

public NumberInput.NumberInputContext getThisContext(@Nullable ComponentContext<?> context)

Description copied from class: AbstractComponent

Gets a real component context using common this trick.

Specified by:

getThisContext in class AbstractComponent<NumberInput.NumberInputContext>

Parameters:

context - the context

Returns:

a component context

read

protected boolean read(org.jline.keymap.BindingReader bindingReader,
 org.jline.keymap.KeyMap<String> keyMap,
 NumberInput.NumberInputContext context)

Description copied from class: AbstractComponent

Read input.

Specified by:

read in class AbstractComponent<NumberInput.NumberInputContext>

Parameters:

bindingReader - the binding reader

keyMap - the key map

context - the context

Returns:

true if read is complete, false to stop