组件渲染

您可以通过以下两种方式实现组件渲染:完全以编程方式或使用ANTLR Stringtemplate。严格来说,有一个简单的Function渲染器接口,它将Context作为输入并输出AttributedString列表。这使您可以在模板和代码之间进行选择。

如果您不需要执行任何复杂操作,或者只想稍微修改现有的组件布局,则模板是一个不错的选择。然后,通过代码进行渲染可以让您灵活地执行任何所需的操作。

以编程方式进行渲染的方法是创建一个Function

class StringInputCustomRenderer implements Function<StringInputContext, List<AttributedString>> {
	@Override
	public List<AttributedString> apply(StringInputContext context) {
		AttributedStringBuilder builder = new AttributedStringBuilder();
		builder.append(context.getName());
		builder.append(" ");
		if (context.getResultValue() != null) {
			builder.append(context.getResultValue());
		}
		else  {
			String input = context.getInput();
			if (StringUtils.hasText(input)) {
				builder.append(input);
			}
			else {
				builder.append("[Default " + context.getDefaultValue() + "]");
			}
		}
		return Arrays.asList(builder.toAttributedString());
	}
}

然后您可以将其挂接到组件上

@ShellMethod(key = "component stringcustom", value = "String input", group = "Components")
public String stringInputCustom(boolean mask) {
	StringInput component = new StringInput(getTerminal(), "Enter value", "myvalue",
			new StringInputCustomRenderer());
	component.setResourceLoader(getResourceLoader());
	component.setTemplateExecutor(getTemplateExecutor());
	if (mask) {
		component.setMaskCharacter('*');
	}
	StringInputContext context = component.run(StringInputContext.empty());
	return "Got value " + context.getResultValue();
}

组件有自己的上下文,但通常会共享来自父组件类型的一些功能。下表显示了这些上下文变量

表 1. TextComponentContext 模板变量
描述

resultValue

组件呈现其结果后的值。

name

组件的名称,即其标题。

message

为组件设置的可能消息。

messageLevel

消息的级别,其中之一为INFOWARNERROR

hasMessageLevelInfo

如果级别为INFO,则返回true。否则返回false。

hasMessageLevelWarn

如果级别为WARN,则返回true。否则返回false。

hasMessageLevelError

如果级别为ERROR,则返回true。否则返回false。

input

原始用户输入。

表 2. SelectorComponentContext 模板变量
描述

name

组件的名称,即其标题。

input

原始用户输入,主要用于过滤。

itemStates

项目状态的完整列表。

itemStateView

项目状态的可见列表。

isResult

如果上下文处于结果模式,则返回true

cursorRow

选择器中的当前光标行。

表 3. ComponentContext 模板变量
描述

terminalWidth

终端的宽度,类型为Integer,如果未设置,则默认为NULL