Skip to content

Fixed an issue where string options do not support IME on >=26.1 #339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Miccebe wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fixed an issue where string options do not support IME on >=26.1 #339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions src/main/java/dev/isxander/yacl3/gui/OptionListWidget.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import net.minecraft.client.input.CharacterEvent;
import net.minecraft.client.input.KeyEvent;
import net.minecraft.client.input.MouseButtonEvent;
import net.minecraft.client.input.PreeditEvent;
import net.minecraft.network.chat.Component;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
Expand Down Expand Up @@ -211,6 +212,16 @@ public boolean charTyped(CharacterEvent characterEvent) {
return super.charTyped(characterEvent);
}

@Override
public boolean preeditUpdated(@Nullable PreeditEvent event) {
for (Entry child : children()) {
if (child.preeditUpdated(event))
return true;
}

return super.preeditUpdated(event);
}

private List<Entry> superModifiableChildren() {
// noinspection unchecked
return (List<Entry>) ((AbstractSelectionListAccessor) this).getChildren();
Expand Down Expand Up @@ -299,6 +310,10 @@ protected void onBecameViewable() {
protected void onBecameHidden() {
this.setHeight(0);
}

public boolean preeditUpdated(@Nullable PreeditEvent event) {
return false;
}
}

public class OptionEntry extends Entry {
Expand Down Expand Up @@ -373,6 +388,11 @@ public boolean charTyped(@NonNull CharacterEvent event) {
return widget.charTyped(event);
}

@Override
public boolean preeditUpdated(@Nullable PreeditEvent event) {
return widget.preeditUpdated(event);
}

@Override
public boolean updateSearchQuery(String searchQuery) {
this.searchQueryMatches = searchQuery.isEmpty()
Expand Down
8 changes: 8 additions & 0 deletions src/main/java/dev/isxander/yacl3/gui/controllers/ListEntryWidget.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import net.minecraft.client.input.CharacterEvent;
import net.minecraft.client.input.KeyEvent;
import net.minecraft.client.input.MouseButtonEvent;
import net.minecraft.client.input.PreeditEvent;
import net.minecraft.network.chat.Component;
import org.jetbrains.annotations.Nullable;
import org.jspecify.annotations.NonNull;
Expand Down Expand Up @@ -159,4 +160,11 @@ public boolean keyReleased(KeyEvent keyEvent) {
public boolean charTyped(CharacterEvent characterEvent) {
return ContainerEventHandler.super.charTyped(characterEvent);
}

@Override
public boolean preeditUpdated(@Nullable PreeditEvent event) {
if (entryWidget.preeditUpdated(event))
return true;
return ContainerEventHandler.super.preeditUpdated(event);
}
}
7 changes: 7 additions & 0 deletions src/main/java/dev/isxander/yacl3/gui/controllers/PopupControllerScreen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
import net.minecraft.client.input.CharacterEvent;
import net.minecraft.client.input.KeyEvent;
import net.minecraft.client.input.MouseButtonEvent;
import net.minecraft.client.input.PreeditEvent;
import org.jetbrains.annotations.Nullable;
import org.jspecify.annotations.NonNull;

public class PopupControllerScreen extends Screen {
Expand Down Expand Up @@ -78,6 +80,11 @@ public boolean charTyped(@NonNull CharacterEvent characterEvent) {
return controllerPopup.charTyped(characterEvent);
}

@Override
public boolean preeditUpdated(@Nullable PreeditEvent event) {
return controllerPopup.preeditUpdated(event);
}

@Override
public boolean keyPressed(@NonNull KeyEvent keyEvent) {
return controllerPopup.keyPressed(keyEvent);
Expand Down
46 changes: 42 additions & 4 deletions src/main/java/dev/isxander/yacl3/gui/controllers/string/StringControllerElement.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,13 @@
import dev.isxander.yacl3.gui.utils.UndoRedoHelper;
import net.minecraft.ChatFormatting;
import net.minecraft.client.gui.GuiGraphicsExtractor;
import net.minecraft.client.gui.components.IMEPreeditOverlay;
import net.minecraft.client.input.CharacterEvent;
import net.minecraft.client.input.KeyEvent;
import net.minecraft.client.input.MouseButtonEvent;
import net.minecraft.client.input.PreeditEvent;
import net.minecraft.network.chat.Component;
import org.jetbrains.annotations.Nullable;
import org.jspecify.annotations.NonNull;

import java.util.function.Consumer;
Expand All @@ -37,6 +40,8 @@ public class StringControllerElement extends ControllerWidget<IStringController<

private final Component emptyText;

private @Nullable IMEPreeditOverlay preeditOverlay;

public StringControllerElement(IStringController<?> control, YACLScreen screen, Dimension<Integer> dim, boolean instantApply) {
super(control, screen, dim);
this.instantApply = instantApply;
Expand Down Expand Up @@ -103,6 +108,14 @@ protected void extractValueText(GuiGraphicsExtractor graphics, int mouseX, int m
} else if (this.hovered) {
graphics.requestCursor(isAvailable() ? com.mojang.blaze3d.platform.cursor.CursorTypes.POINTING_HAND : com.mojang.blaze3d.platform.cursor.CursorTypes.NOT_ALLOWED);
}

if (preeditOverlay != null && inputFieldFocused) {
String text = getValueText().getString();
int preeditTextX = getDimension().xLimit() - textRenderer.width(getValueText()) + renderOffset - getXPadding();
int preeditCaretX = preeditTextX + textRenderer.width(text.substring(0, Math.min(caretPos, text.length())));
preeditOverlay.updateInputPosition(preeditCaretX, getTextY());
graphics.setPreeditOverlay(preeditOverlay);
}
}

private boolean isHoveredInputField(double mouseX, double mouseY) {
Expand All @@ -112,7 +125,7 @@ private boolean isHoveredInputField(double mouseX, double mouseY) {
@Override
public boolean mouseClicked(@NonNull MouseButtonEvent event, boolean doubleClick) {
if (isAvailable() && getDimension().isPointInside((int) event.x(), (int) event.y())) {
inputFieldFocused = true;
setInputEditing(true);

if (!isHoveredInputField(event.x(), event.y())) {
caretPos = getDefaultCaretPos();
Expand Down Expand Up @@ -322,16 +335,31 @@ protected void checkRenderOffset() {
}
}

public boolean canConsumeInput() {
return inputFieldFocused && isAvailable();
}

@Override
public boolean charTyped(@NonNull CharacterEvent event) {
if (!inputFieldFocused)
if (!canConsumeInput())
return false;

write(event.codepointAsString());
updateUndoHistory();
return true;
}

@Override
public boolean preeditUpdated(@Nullable PreeditEvent event) {
if (!canConsumeInput())
return false;

preeditOverlay = event != null
? new IMEPreeditOverlay(event, textRenderer, textRenderer.lineHeight + 1)
: null;
return true;
}

protected void doBackspace() {
if (selectionLength != 0) {
write("");
Expand Down Expand Up @@ -431,17 +459,27 @@ protected int findSpaceIndex(boolean reverse) {
@Override
public void setFocused(boolean focused) {
super.setFocused(focused);
inputFieldFocused = focused;
setInputEditing(focused);
}

@Override
public void unfocus() {
setInputEditing(false);
super.unfocus();
inputFieldFocused = false;
renderOffset = 0;
if (!instantApply) updateControl();
}

private void setInputEditing(boolean editing) {
if (inputFieldFocused == editing)
return;

inputFieldFocused = editing;
client.onTextInputFocusChange(this, editing);
if (!editing)
preeditOverlay = null;
}

@Override
public void setDimension(Dimension<Integer> dim) {
super.setDimension(dim);
Expand Down