aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/dev/isxander/yacl3/gui/controllers/string/IStringController.java
blob: 14d10ddd85d7418cce5679b047b1a5b22cea3c05 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
package dev.isxander.yacl3.gui.controllers.string;

import dev.isxander.yacl3.api.Controller;
import dev.isxander.yacl3.api.Option;
import dev.isxander.yacl3.api.utils.Dimension;
import dev.isxander.yacl3.gui.AbstractWidget;
import dev.isxander.yacl3.gui.YACLScreen;
import net.minecraft.network.chat.Component;

/**
 * A controller that can be any type but can input and output a string.
 */
public interface IStringController<T> extends Controller<T> {
    /**
     * Gets the option's pending value as a string.
     *
     * @see Option#pendingValue()
     */
    String getString();

    /**
     * Sets the option's pending value from a string.
     *
     * @see Option#requestSet(Object)
     */
    void setFromString(String value);

    /**
     * {@inheritDoc}
     */
    @Override
    default Component formatValue() {
        return Component.literal(getString());
    }

    default boolean isInputValid(String input) {
        return true;
    }

    @Override
    default AbstractWidget provideWidget(YACLScreen screen, Dimension<Integer> widgetDimension) {
        return new StringControllerElement(this, screen, widgetDimension, true);
    }
}