Package org.apache.juneau.console.freemarker

Class SearchSection

java.lang.Object

org.apache.juneau.console.freemarker.Section

org.apache.juneau.console.freemarker.SearchSection

public final class SearchSection
extends Section

A rail section with one text input.

Publishes {schemaVersion:1, viewId, search} on Enter and after a 250 ms pause in typing.

Example:

SearchSection.create().placeholder("status:open").publishes(Topics.filter("search"));

Since:

10.0.0

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.juneau.console.freemarker.Section

Section.Custom

Method Summary

Modifier and Type	Method	Description
static SearchSection	create()
SearchSection	label(String label)	Sets the section's legend text.
SearchSection	placeholder(String value)	Sets the input's placeholder text.
SearchSection	publishes(String topic)	Sets the topic this section owns.

Methods inherited from class org.apache.juneau.console.freemarker.Section

custom

Methods inherited from class java.lang.Object

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

Method Details

create

public static SearchSection create()

Returns:

A new section.

placeholder

public SearchSection placeholder(String value)

Sets the input's placeholder text.

Parameters:

value - The placeholder.

Returns:

This object.

publishes

public SearchSection publishes(String topic)

Description copied from class: Section

Sets the topic this section owns.

Overrides:

publishes in class Section

Parameters:

topic - A filter:<key> topic, normally Topics.filter(key). <key> becomes the section id.

Returns:

This object.

label

public SearchSection label(String label)

Description copied from class: Section

Sets the section's legend text.

Overrides:

label in class Section

Parameters:

label - The label.

Returns:

This object.