com.teamdev.jxbrowser.dom.event

Class KeyEventParams.Builder

java.lang.Object

com.teamdev.jxbrowser.dom.event.KeyEventParams.Builder

Enclosing interface:

KeyEventParams

public static final class KeyEventParams.Builder
extends java.lang.Object

A builder of KeyEventParams.

Builders are created by invoking KeyEventParams.newBuilder(). Each of the setter methods modifies the state of the builder and returns the same instance. Builders are not thread-safe and should not be used concurrently from multiple threads without external synchronization.

Method Summary

Modifier and Type	Method and Description
KeyEventParams	build() Returns a new KeyEventParams instance built from the current state of this builder.
KeyEventParams.Builder	character(java.lang.String character) Sets a string that contains either a UTF-8 character associated with the physical key or one of the predefined values.
KeyEventParams.Builder	domKeyCode(DomKeyCode code) Sets the code of the physical key.
KeyEventParams.Builder	uiEventModifierParams(UiEventModifierParams uiEventModifierParams) Sets the DOM UI event parameters with the key modifiers.

Methods inherited from class java.lang.Object

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

Method Detail

uiEventModifierParams

public KeyEventParams.Builder uiEventModifierParams(UiEventModifierParams uiEventModifierParams)

Sets the DOM UI event parameters with the key modifiers.

Parameters:

uiEventModifierParams - the DOM UI event parameters with the key modifiers

Returns:

this builder

domKeyCode

public KeyEventParams.Builder domKeyCode(DomKeyCode code)

Sets the code of the physical key.

Returns:

this builder

Since:

7.12

character

public KeyEventParams.Builder character(java.lang.String character)

Sets a string that contains either a UTF-8 character associated with the physical key or one of the predefined values.

The set of predefined values is defined in the W3C specification.

Returns:

this builder

Since:

7.12

build

public KeyEventParams build()

Returns a new KeyEventParams instance built from the current state of this builder.

Returns:

a new KeyEventParams instance