Interface UiEventModifierParams

All Superinterfaces:
EventParams
All Known Subinterfaces:
KeyEventParams, MouseEventParams, WheelEventParams

public interface UiEventModifierParams extends EventParams
The DOM UI event parameters with the key modifiers.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    A builder of UiEventModifierParams.
  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    Returns true if the event bubbles up through the DOM.
    default boolean
    Returns true if the event can be canceled, and therefore prevented as if the event never happened.
    default boolean
    Returns true if the event is trusted, and therefore was generated by a user action.
    default KeyModifiers
    Returns the key modifiers that are applied to the event.
    Creates a new UiEventModifierParams builder.
  • Method Details

    • newBuilder

      static UiEventModifierParams.Builder newBuilder()
      Creates a new UiEventModifierParams builder.
      Returns:
      a new UiEventModifierParams.Builder instance
    • isBubbles

      default boolean isBubbles()
      Returns true if the event bubbles up through the DOM.
      Specified by:
      isBubbles in interface EventParams
    • isTrusted

      default boolean isTrusted()
      Returns true if the event is trusted, and therefore was generated by a user action.
      Specified by:
      isTrusted in interface EventParams
      Since:
      7.12
    • isCancelable

      default boolean isCancelable()
      Returns true if the event can be canceled, and therefore prevented as if the event never happened.
      Specified by:
      isCancelable in interface EventParams
    • keyModifiers

      default KeyModifiers keyModifiers()
      Returns the key modifiers that are applied to the event.