Class ScreenEvent.Preedit

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.ScreenEvent

net.neoforged.neoforge.client.event.ScreenEvent.Preedit

Direct Known Subclasses:

ScreenEvent.Preedit.Post, ScreenEvent.Preedit.Pre

Enclosing class:

ScreenEvent

public abstract static class ScreenEvent.Preedit
extends ScreenEvent

Fired when an Input Method Editor (IME) preedit event is received by a screen.

An IME lets users enter text that is not directly available from their keyboard, such as Chinese, Japanese, and Korean characters. While input is being composed, the IME supplies temporary preedit text that can change until the user commits it.

See Also:

• ScreenEvent.Preedit.Pre
• ScreenEvent.Preedit.Post
• GuiEventListener.preeditUpdated(PreeditEvent)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScreenEvent.Preedit.Post	Fired after the screen's preedit handler, only if the corresponding Pre event is not canceled and the screen's preedit handler returns false.
static class	ScreenEvent.Preedit.Pre	Fired before the preedit event is received by the screen's preedit handler.

Nested classes/interfaces inherited from class ScreenEvent

ScreenEvent.CharacterTyped, ScreenEvent.Closing, ScreenEvent.Init, ScreenEvent.KeyPressed, ScreenEvent.KeyReleased, ScreenEvent.MouseButtonPressed, ScreenEvent.MouseButtonReleased, ScreenEvent.MouseDragged, ScreenEvent.MouseScrolled, ScreenEvent.Opening, ScreenEvent.Preedit, ScreenEvent.Render, ScreenEvent.RenderInventoryMobEffects

Field Summary

Fields

Modifier and Type	Field	Description
private final @Nullable PreeditEvent	preeditEvent

Constructor Summary

Constructors

Constructor	Description
Preedit(Screen screen, @Nullable PreeditEvent preeditEvent)

Method Summary

Modifier and Type	Method	Description
@Nullable PreeditEvent	getPreeditEvent()	Returns the current preedit composition, or null if there is no active composition.

Methods inherited from class ScreenEvent

getScreen

Methods inherited from class Object

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

Field Details

preeditEvent

private final @Nullable PreeditEvent preeditEvent

Constructor Details

Preedit

@Internal
public Preedit(Screen screen,
 @Nullable PreeditEvent preeditEvent)

Method Details

getPreeditEvent

public @Nullable PreeditEvent getPreeditEvent()

Returns the current preedit composition, or null if there is no active composition.

Returns:

the current preedit composition, or null if there is no active composition