Field Widget#

Back To User Interface

Field widget is an extension of Text which allows for user input.

Properties#

In addition to all Text properties, field also has these properties:

Property	Description
defaultBackground	The default input background
focusBackground	The input background when focused
padding	The padding for the input box
focusListener	The handler which gets invoked when focus changes
keyCharListener	The handler which gets invoked when keys are pressed inside the field
changeListener	The change event handler to invoke when the field text changes

Usage#

Field.create(
  props -> {
    props.defaultBackground = IO.getImage("default-bg.png");
    props.focusBackground = IO.getImage("focus-bg.png");
    props.padding = new Spacing(10, 20, 10, 24);
    props.focusListener = (event) -> {
      switch (event.type) {
        case FocusEvent.Type.FOCUS -> System.out.println("Gained focus");
        case FocusEvent.Type.BLUR -> System.out.println("Lost focus");
      }
    };
    props.keyCharListener = (event) -> {
      System.out.println("Pressed key character: " + event.charPressed);
    };
    props.changeListener = (event) -> {
      System.out.println("Value changed: " + event.value);
    };

    // Inherited from Text
    props.text = "Hello GameKit";
    props.font = IO.getResourceFont("custom-font.ttf");
    props.fontSize = 24;
    props.fontHeightRatio = 0.9;
    props.fontStyle = Text.ITALIC;
    props.color = Color.RED;
    props.backgroundColor = Color.WHITE;
    props.alignment = Alignment.CENTER;
    props.shadowEnabled = true;
    props.shadowOffsetX = 2;
    props.shadowOffsetY = 3;
    props.shadowColor = Color.BLUE;
  }
);