Interface Event

  • All Implemented Interfaces:

    
    public interface Event
    
                        

    Events are how PolyUI communicates between components and to the user.

    Everything from mouse clicks, key presses, text input changes, initialization and destruction of components are communicated through events.

    Some events are specific, requiring constructor parameters to ensure that for example, only single, left-click events are handled by any given handler, whereas others are non-specific, like Focused.UnmappedInput and receive any matching event of the type.

    These events can be dispatched by your own components, and you can add your own events - though PolyUI comes with 22 events by default.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public interface Event.Mouse

      Events related to the mouse.

      public interface Event.Lifetime

      Events related to the lifetime of a component.

      public abstract class Event.Change

      Events related to specific things that occur in some components, for example when a switch is toggled, a slider is moved or a text is changed.

      These events can be cancelled, meaning that the change in state will not occur.

      public interface Event.Focused

      Events for focusable components (components which receive keyboard input)

      In order to receive these events, the focusable flag must be true.

      public abstract class Event.WithMods

      Extend this class if your event has modifiers attached to it.

      Provides various utility methods to check for modifiers.

    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail