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

Class AbstractSelectorComponent<T,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>,I extends Nameable & Matchable & Enableable & Selectable & Itemable<T>>

java.lang.Object

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

org.springframework.shell.jline.tui.component.support.AbstractSelectorComponent<T,C,I>

All Implemented Interfaces:

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

Direct Known Subclasses:

MultiItemSelector, SingleItemSelector

public abstract class AbstractSelectorComponent<T,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>,I extends Nameable & Matchable & Enableable & Selectable & Itemable<T>>
extends AbstractComponent<C>

Base component for selectors which provide selectable lists.

Author:

Janne Valkealahti, Piotr Olaszewski

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractSelectorComponent.BaseSelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>	Base implementation of a AbstractSelectorComponent.SelectorComponentContext.
static class	AbstractSelectorComponent.ItemState<I extends Matchable>	Class keeping item state.
static interface	AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>	Context interface on a selector component sharing content.

Field Summary

Fields

Modifier and Type	Field	Description
protected final @Nullable String	name

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
AbstractSelectorComponent(org.jline.terminal.Terminal terminal, @Nullable String name, List<I> items, boolean exitSelects, @Nullable Comparator<I> comparator)

Method Summary

Modifier and Type	Method	Description
protected void	bindKeyMap(org.jline.keymap.KeyMap<String> keyMap)	Bind key map.
Function<T,String>	getItemMapper()	Gets an item mapper.
protected List<I>	getItems()	Gets items.
protected boolean	read(org.jline.keymap.BindingReader bindingReader, org.jline.keymap.KeyMap<String> keyMap, C context)	Read input.
protected C	runInternal(C context)	Run internal logic called from public run method.
void	setDefaultExpose(@Nullable I defaultExpose)	Sets default expose item when component start.
void	setItemMapper(Function<T,String> itemMapper)	Sets an item mapper.
void	setMaxItems(int maxItems)	Set max items to show.

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

addPostRunHandler, addPreRunHandler, getTemplateExecutor, getTerminal, getThisContext, 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

Field Details

name

protected final @Nullable String name

Constructor Details

AbstractSelectorComponent

public AbstractSelectorComponent(org.jline.terminal.Terminal terminal,
 @Nullable String name,
 List<I> items,
 boolean exitSelects,
 @Nullable Comparator<I> comparator)

Method Details

setMaxItems

public void setMaxItems(int maxItems)

Set max items to show.

Parameters:

maxItems - max items

setItemMapper

public void setItemMapper(Function<T,String> itemMapper)

Sets an item mapper.

Parameters:

itemMapper - the item mapper

getItemMapper

public Function<T,String> getItemMapper()

Gets an item mapper.

Returns:

setDefaultExpose

public void setDefaultExpose(@Nullable I defaultExpose)

Sets default expose item when component start.

Parameters:

defaultExpose - the default item

getItems

protected List<I> getItems()

Gets items.

Returns:

a list of items

bindKeyMap

protected void bindKeyMap(org.jline.keymap.KeyMap<String> keyMap)

Description copied from class: AbstractComponent

Bind key map.

Specified by:

bindKeyMap in class AbstractComponent<C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

runInternal

protected C runInternal(C context)

Description copied from class: AbstractComponent

Run internal logic called from public run method.

Specified by:

runInternal in class AbstractComponent<C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

Parameters:

context - the context

Returns:

a context

read

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

Description copied from class: AbstractComponent

Read input.

Specified by:

read in class AbstractComponent<C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>

Parameters:

bindingReader - the binding reader

keyMap - the key map

context - the context

Returns:

true if read is complete, false to stop