Package com.teamdev.jxbrowser.dom.event

Interface CustomEventParams

All Superinterfaces:
EventParams
public interface CustomEventParams extends EventParams
The parameters of the custom DOM event.
Since:
7.21

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    CustomEventParams.Builder
    A builder of CustomEventParams.

  • Method Summary

    Modifier and Type
    Method
    Description
    default <T> T
    detail()
    Returns the payload of the custom event.
    default boolean
    isBubbles()
    Returns true if the event bubbles up through the DOM.
    default boolean
    isCancelable()
    Returns true if the event can be canceled, and therefore prevented as if the event never happened.
    default boolean
    isTrusted()
    Returns true if the event is trusted, and therefore was generated by a user action.
    static CustomEventParams.Builder
    newBuilder(Document document)
    Creates a new CustomEventParams builder.

  • Method Details

    • newBuilder

      static CustomEventParams.Builder newBuilder(Document document)
      Creates a new CustomEventParams builder.
      Parameters:
      document - The document where this event will be dispatched.
      Returns:
      a new CustomEventParams.Builder instance
      Since:
      8.0.0

    • isBubbles

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

    • isCancelable

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

    • isTrusted

      default boolean isTrusted()
      Description copied from interface: EventParams
      Returns true if the event is trusted, and therefore was generated by a user action.
      Specified by:
      isTrusted in interface EventParams

    • detail

      default <T> T detail()
      Returns the payload of the custom event.

      The type mapping rules are the following: 

       | JavaScript         | Java           |
 |--------------------|----------------|
 | Number             | Double         |
 | BigInt             | BigInteger     |
 | String             | String         |
 | Boolean            | Boolean        |
 | Symbol             | JsSymbol       |
 | null and undefined | null           |
 | Node               | JsObject, Node |
 | ArrayBuffer        | JsArrayBuffer  |
 | Array              | JsArray        |
 | Set                | JsSet          |
 | Map                | JsMap          |
 | Object             | JsObject       |
 | Proxy Object       | Object         |

      Proxy objects are mapped to the corresponding injected Java object.

      Type Parameters:
      T - the result type according to the type mapping rules
      Returns:
      the object from the detail field of the CustomEvent.