edrowsluo / searchables Goto Github PK

public record Shape(String name, String type, String colour) {}
    
public static final List<Shape> SHAPES = List.of(
        new Shape("one", "square", "red"),
        new Shape("two", "square", "dark blue"),
        new Shape("three", "circle", "red"),
        new Shape("four", "triangle", "yellow")
);

public static final SearchableType<Shape> SHAPE = new SearchableType.Builder<Shape>() // Starts a builder
            .defaultComponent(SearchableComponent.create("name", shape -> Optional.of(shape.name()))) // Sets the name of the shape as the default component
            .component(SearchableComponent.create("type", shape -> Optional.of(shape.type()))) // Adds a new component for the type of the shape
            .component(SearchableComponent.create("color", shape -> Optional.of(shape.colour()))) // Adds a new component for the color of the shape
            .build();

SHAPE.filterEntries(SHAPES, "one"); // Returns a list with a single entry of Shape("one", "square", "red") - When searching for a default component, you don't need to specify the key
SHAPE.filterEntries(SHAPES, "color:red"); // Returns a list with the entries, Shape("one", "square", "red") and Shape("three", "circle", "red")
SHAPE.filterEntries(SHAPES, "one color:red"); // Returns a list with a single entry of Shape("one", "square", "red")
SHAPE.filterEntries(SHAPES, "color:red one"); // Returns a list with a single entry of Shape("one", "square", "red") - The search itself can be in any order
SHAPE.filterEntries(SHAPES, "color:'dark blue'"); // Returns a list with a single entry of Shape("two", "square", "dark blue") - terms with spaces, or quote characters need to be quoted - valid quote characters are '"`

public class MyScreen extends Screen {
    
    private AutoCompletingEditBox<TestConstants.Shape> search;
    
    protected MyScreen(Component title) {
        super(title);
    }
    
    @Override
    protected void init() {
        super.init();
        this.search = addRenderableWidget(new AutoCompletingEditBox<>(
                font, // The Font used for rendering text
                width / 2 - 75, // x
                22, // y
                Button.DEFAULT_WIDTH, // width
                Button.DEFAULT_HEIGHT, // height
                search, // This box - Used when init is re-run to carry over the old value
                SearchablesConstants.COMPONENT_SEARCH, // Message to display when the search is empty and unfocused
                TestConstants.SHAPE, // The SearchableType that will be searched
                () -> TestConstants.SHAPES)); // Supplier for the elements - used for auto complete
        this.search.addResponder(this::filter); // Adds a responder to the search to filter the elements on every change in the EditBox
        this.addRenderableOnly(this.search.autoComplete()); // Add the autocomplete widget as a renderable only
    }
    
    @Override
    public void tick() {
        super.tick();
        this.search.tick(); // Assists rendering the EditBox's cursor
    }
    
    @Override
    public boolean mouseScrolled(double xpos, double ypos, double delta) {
        // This is required to be able to scroll on the autocomplete widget to scroll
        if(search.autoComplete().mouseScrolled(xpos, ypos, delta)) {
            return true;
        }
        return super.mouseScrolled(xpos, ypos, delta);
    }

}