com.aspose.html.dom.events

Class KeyboardEvent.KeyboardEventInit

java.lang.Object

com.aspose.ms.System.Collections.Generic.Dictionary<java.lang.String,java.lang.Object>

com.aspose.html.dom.events.Event.EventInit

com.aspose.html.dom.events.UIEvent.UIEventInit

com.aspose.html.dom.events.UIEvent.EventModifierInit

com.aspose.html.dom.events.KeyboardEvent.KeyboardEventInit

All Implemented Interfaces:

com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.Object>>, com.aspose.ms.System.Collections.Generic.IGenericDictionary<java.lang.String,java.lang.Object>, com.aspose.ms.System.Collections.Generic.IGenericEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.Object>>, com.aspose.ms.System.Collections.IEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.Object>>, java.lang.Iterable<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.Object>>

Enclosing class:

KeyboardEvent

public class KeyboardEvent.KeyboardEventInit
extends UIEvent.EventModifierInit

Represents a dictionary that is having optional arguments for setting the details information about the event.

Nested Class Summary

Nested classes/interfaces inherited from class com.aspose.ms.System.Collections.Generic.Dictionary

com.aspose.ms.System.Collections.Generic.Dictionary.Enumerator<TKey,TValue>, com.aspose.ms.System.Collections.Generic.Dictionary.KeyCollection<TKey,TValue>, com.aspose.ms.System.Collections.Generic.Dictionary.Link, com.aspose.ms.System.Collections.Generic.Dictionary.ValueCollection<TKey,TValue>

Constructor Summary

Constructors

Constructor and Description
KeyboardEventInit()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode() The code holds a string that identifies the physical key being pressed.
java.lang.String	getKey() The key holds the key value of the key pressed.
long	getLocation() The location attribute contains an indication of the logical location of the key on the device.
boolean	getRepeat() true if the key has been pressed in a sustained manner.
boolean	isComposing() true if the key event occurs as part of a composition session, i.e., after a compositionstart event and before the corresponding compositionend event.
void	setCode(java.lang.String value) The code holds a string that identifies the physical key being pressed.
void	setComposing(boolean value) true if the key event occurs as part of a composition session, i.e., after a compositionstart event and before the corresponding compositionend event.
void	setKey(java.lang.String value) The key holds the key value of the key pressed.
void	setLocation(long value) The location attribute contains an indication of the logical location of the key on the device.
void	setRepeat(boolean value) true if the key has been pressed in a sustained manner.

Methods inherited from class com.aspose.html.dom.events.UIEvent.EventModifierInit

getAltKey, getCtrlKey, getMetaKey, getModifierAltGraph, getModifierCapsLock, getModifierFn, getModifierFnLock, getModifierHyper, getModifierNumLock, getModifierScrollLock, getModifierSuper, getModifierSymbol, getModifierSymbolLock, getShiftKey, setAltKey, setCtrlKey, setMetaKey, setModifierAltGraph, setModifierCapsLock, setModifierFn, setModifierFnLock, setModifierHyper, setModifierNumLock, setModifierScrollLock, setModifierSuper, setModifierSymbol, setModifierSymbolLock, setShiftKey

Methods inherited from class com.aspose.html.dom.events.UIEvent.UIEventInit

getDetail, getView, setDetail, setView

Methods inherited from class com.aspose.html.dom.events.Event.EventInit

getBubbles, getCancelable, isTrusted, setBubbles, setCancelable, setTrusted

Methods inherited from class com.aspose.ms.System.Collections.Generic.Dictionary

addItem, addItem, clear, containsItem, containsKey, containsValue, copyTo, copyToTArray, get_Item, getComparer, getDictionaryEntryEnumerator, getKeys, getSyncRoot, getValues, isFixedSize, isReadOnly, isSynchronized, iterator, removeItem, removeItemByKey, set_Item, size, tryGetValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

KeyboardEventInit

public KeyboardEventInit()

Method Detail

getKey

public java.lang.String getKey()

The key holds the key value of the key pressed. If the value is has a printed representation, it MUST be a non-empty Unicode character string, conforming to the algorithm for determining the key value defined in this specification. If the value is a control key which has no printed representation, it MUST be one of the key values defined in the key values set, as determined by the algorithm for determining the key value. Implementations that are unable to identify a key MUST use the key value Unidentified.

Value: The key value.

setKey

public void setKey(java.lang.String value)

The key holds the key value of the key pressed. If the value is has a printed representation, it MUST be a non-empty Unicode character string, conforming to the algorithm for determining the key value defined in this specification. If the value is a control key which has no printed representation, it MUST be one of the key values defined in the key values set, as determined by the algorithm for determining the key value. Implementations that are unable to identify a key MUST use the key value Unidentified.

Value: The key value.

getCode

public java.lang.String getCode()

The code holds a string that identifies the physical key being pressed. The value is not affected by the current keyboard layout or modifier state, so a particular key will always return the same value.

Value: The key code.

setCode

public void setCode(java.lang.String value)

The code holds a string that identifies the physical key being pressed. The value is not affected by the current keyboard layout or modifier state, so a particular key will always return the same value.

Value: The key code.

getLocation

public long getLocation()

The location attribute contains an indication of the logical location of the key on the device.

Value: The location.

setLocation

public void setLocation(long value)

The location attribute contains an indication of the logical location of the key on the device.

Value: The location.

getRepeat

public boolean getRepeat()

true if the key has been pressed in a sustained manner. Holding down a key MUST result in the repeating the events keydown, beforeinput, input in this order, at a rate determined by the system configuration. For mobile devices which have long-key-press behavior, the first key event with a repeat attribute value of true MUST serve as an indication of a long-key-press. The length of time that the key MUST be pressed in order to begin repeating is configuration-dependent.

Value: true if repeat; otherwise, false.

setRepeat

public void setRepeat(boolean value)

true if the key has been pressed in a sustained manner. Holding down a key MUST result in the repeating the events keydown, beforeinput, input in this order, at a rate determined by the system configuration. For mobile devices which have long-key-press behavior, the first key event with a repeat attribute value of true MUST serve as an indication of a long-key-press. The length of time that the key MUST be pressed in order to begin repeating is configuration-dependent.

Value: true if repeat; otherwise, false.

isComposing

public boolean isComposing()

true if the key event occurs as part of a composition session, i.e., after a compositionstart event and before the corresponding compositionend event. The un-initialized value of this attribute MUST be false.

Value: true if this instance is composing; otherwise, false.

setComposing

public void setComposing(boolean value)

true if the key event occurs as part of a composition session, i.e., after a compositionstart event and before the corresponding compositionend event. The un-initialized value of this attribute MUST be false.

Value: true if this instance is composing; otherwise, false.