JavaScript API Reference for Oracle ADF Faces

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.adf.view.js.base
Class AdfKeyStroke

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.base.AdfKeyStroke

public class AdfKeyStroke
extends AdfObject

See also:

getKeyStrokeFromMarshalledString(Object)

getKeyStroke(Number, Number)

Field Summary

public static Object	A_KEY
public static Number	ALT_KEY KeyCode representing Alt key.
public static Number	ALT_MASK Modifiers, bit mask value if Alt key is pressed
private static Object	_ALT_MODIFIER
public static Number	ARROWDOWN_KEY KeyCode representing Down Arrow key.
public static Number	ARROWLEFT_KEY KeyCode representing left arrow key.
public static Number	ARROWRIGHT_KEY KeyCode representing right arrow key.
public static Number	ARROWUP_KEY KeyCode representing Up Arrow key.
public static Number	BACKSPACE_KEY KeyCode representing backspace key.
public static Object	C_KEY
private static Object	_CACHE
public static Number	CTRL_MASK Modifiers, bit mask value if Control key is pressed
private static Object	_CTRL_MODIFIER
public static Object	DELETE_KEY
public static Object	END_KEY
public static Number	ENTER_KEY KeyCode representing enter key.
public static Number	ESC_KEY KeyCode representing esc key.
public static Number	F10_KEY KeyCode representing F10 key.
public static Number	F11_KEY KeyCode representing F11 key.
public static Number	F12_KEY KeyCode representing F12 key.
public static Number	F1_KEY KeyCode representing F1 key.
public static Number	F2_KEY KeyCode representing F2 key.
public static Number	F3_KEY KeyCode representing F3 key.
public static Number	F4_KEY KeyCode representing F4 key.
public static Number	F5_KEY KeyCode representing F5 key.
public static Number	F6_KEY KeyCode representing F6 key.
public static Number	F7_KEY KeyCode representing F7 key.
public static Number	F8_KEY KeyCode representing F8 key.
public static Number	F9_KEY KeyCode representing F9 key.
public static Object	HOME_KEY
public static Object	INSERT_KEY
private Object	_keyCode
private static Object	_KEYCODE_MAPPINGS
public static Number	M_KEY KeyCode representing M key.
public static Number	META_MASK Modifiers, bit mask value if Meta key is pressed
private static Object	_META_MODIFIER
private static Object	_MODIFIER_DISPLAY_STRINGS
private static Object	_MODIFIER_NAME_TO_FLAG
private static Object	_MODIFIER_STRINGS
private Object	_modifiers
public static Number	P_KEY KeyCode representing P key.
public static Number	PAGEDOWN_KEY KeyCode representing Page Down key.
public static Number	PAGEUP_KEY KeyCode representing Page Up key.
public static Number	R_KEY KeyCode representing R key.
public static Number	SHIFT_MASK Modifiers, bit mask value if Shift key is pressed
private static Object	_SHIFT_MODIFIER
public static Number	SPACE_KEY KeyCode representing space key.
private Object	_stringForm
public static Number	TAB_KEY KeyCode representing tab key.
public static Number	V_KEY KeyCode representing V key.
public static Number	W_KEY KeyCode representing W key.
public static Number	X_KEY KeyCode representing X key.

Fields inherited from oracle.adf.view.js.base.AdfObject

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Constructor Summary

public

AdfKeyStroke(Number keyCode, Number modifiers, String stringForm)

Method Summary

public Number	getKeyCode()
public static AdfKeyStroke	getKeyStroke(Number keyCode, Number modifiers) Factory method used by code to create AdfKeyStrokes
public static AdfKeyStroke	getKeyStrokeFromMarshalledString(Object keyString) Factory method used by marshalling code to create AdfKeyStrokes
private static String	_getModifierDisplayString(Number modifiers) Returns the human-readable concatenated value for the modifiers string
public Number	getModifiers()
private static String	_getModifierString(Number modifiers) Returns the concatenated value for the modifiers string
private static Object	_getNameFromKeyCode(Object keyCode) Returns a canonical key name corresponding to the keycode
private static String	_getStringForm(Object keyCode, Object modifiers)
protected Object	Init(Number keyCode, Number modifiers, String stringForm) Initializes the instance.
protected static Object	InitClass() Initializes the AdfKeyStroke class
public String	toMarshalledString() Returns a canonical String representation of the AdfKeyStroke object.
public Object	toString()

Methods inherited from oracle.adf.view.js.base.AdfObject

adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toDebugString

Field Detail

A_KEY

public static Object A_KEY

ALT_KEY

public static Number ALT_KEY

KeyCode representing Alt key. Not sent by Firefox.

ALT_MASK

public static Number ALT_MASK

Modifiers, bit mask value if Alt key is pressed

See also:

SHIFT_MASK

CTRL_MASK

META_MASK

_ALT_MODIFIER

private static Object _ALT_MODIFIER

ARROWDOWN_KEY

public static Number ARROWDOWN_KEY

KeyCode representing Down Arrow key. Not sent by Firefox.

ARROWLEFT_KEY

public static Number ARROWLEFT_KEY

KeyCode representing left arrow key.

ARROWRIGHT_KEY

public static Number ARROWRIGHT_KEY

KeyCode representing right arrow key.

ARROWUP_KEY

public static Number ARROWUP_KEY

KeyCode representing Up Arrow key. Not sent by Firefox.

BACKSPACE_KEY

public static Number BACKSPACE_KEY

KeyCode representing backspace key.

C_KEY

public static Object C_KEY

_CACHE

private static Object _CACHE

CTRL_MASK

public static Number CTRL_MASK

Modifiers, bit mask value if Control key is pressed

See also:

SHIFT_MASK

META_MASK

ALT_MASK

_CTRL_MODIFIER

private static Object _CTRL_MODIFIER

DELETE_KEY

public static Object DELETE_KEY

END_KEY

public static Object END_KEY

ENTER_KEY

public static Number ENTER_KEY

KeyCode representing enter key.

ESC_KEY

public static Number ESC_KEY

KeyCode representing esc key.

F10_KEY

public static Number F10_KEY

KeyCode representing F10 key.

F11_KEY

public static Number F11_KEY

KeyCode representing F11 key. Not sent by Internet Explorer.

F12_KEY

public static Number F12_KEY

KeyCode representing F12 key.

F1_KEY

public static Number F1_KEY

KeyCode representing F1 key.

F2_KEY

public static Number F2_KEY

KeyCode representing F2 key.

F3_KEY

public static Number F3_KEY

KeyCode representing F3 key.

F4_KEY

public static Number F4_KEY

KeyCode representing F4 key. Not sent by Internet Explorer.

F5_KEY

public static Number F5_KEY

KeyCode representing F5 key.

F6_KEY

public static Number F6_KEY

KeyCode representing F6 key.

F7_KEY

public static Number F7_KEY

KeyCode representing F7 key.

F8_KEY

public static Number F8_KEY

KeyCode representing F8 key.

F9_KEY

public static Number F9_KEY

KeyCode representing F9 key.

HOME_KEY

public static Object HOME_KEY

INSERT_KEY

public static Object INSERT_KEY

_keyCode

private Object _keyCode

_KEYCODE_MAPPINGS

private static Object _KEYCODE_MAPPINGS

M_KEY

public static Number M_KEY

KeyCode representing M key.

META_MASK

public static Number META_MASK

Modifiers, bit mask value if Meta key is pressed

See also:

SHIFT_MASK

CTRL_MASK

ALT_MASK

_META_MODIFIER

private static Object _META_MODIFIER

_MODIFIER_DISPLAY_STRINGS

private static Object _MODIFIER_DISPLAY_STRINGS

_MODIFIER_NAME_TO_FLAG

private static Object _MODIFIER_NAME_TO_FLAG

_MODIFIER_STRINGS

private static Object _MODIFIER_STRINGS

_modifiers

private Object _modifiers

P_KEY

public static Number P_KEY

KeyCode representing P key.

PAGEDOWN_KEY

public static Number PAGEDOWN_KEY

KeyCode representing Page Down key. Not sent by Firefox.

PAGEUP_KEY

public static Number PAGEUP_KEY

KeyCode representing Page Up key. Not sent by Firefox.

R_KEY

public static Number R_KEY

KeyCode representing R key.

SHIFT_MASK

public static Number SHIFT_MASK

Modifiers, bit mask value if Shift key is pressed

See also:

CTRL_MASK

META_MASK

ALT_MASK

_SHIFT_MODIFIER

private static Object _SHIFT_MODIFIER

SPACE_KEY

public static Number SPACE_KEY

KeyCode representing space key.

_stringForm

private Object _stringForm

TAB_KEY

public static Number TAB_KEY

KeyCode representing tab key.

V_KEY

public static Number V_KEY

KeyCode representing V key.

W_KEY

public static Number W_KEY

KeyCode representing W key.

X_KEY

public static Number X_KEY

KeyCode representing X key.

Constructor Detail

AdfKeyStroke

public AdfKeyStroke(Number keyCode,
Number modifiers,
String stringForm)

Parameters:

keyCode	-	Unicode character of key to press
modifiers	-	bitmask of modifiers that must be held down
stringForm	-	Marshallable string version of keyCode and modifiers

Method Detail

getKeyCode

public Number getKeyCode()

Return:

Number - The Unicode keycode for the key pressed

getKeyStroke

public static AdfKeyStroke getKeyStroke(Number keyCode,
Number modifiers)

Factory method used by code to create AdfKeyStrokes

Parameters:

keyCode	-	Unicode character of key to press
modifiers	-	bitmask of modifiers that must be held down

Return:

AdfKeyStroke - A shared AdfKeyStroke instance

getKeyStrokeFromMarshalledString

public static AdfKeyStroke getKeyStrokeFromMarshalledString(Object keyString)

Factory method used by marshalling code to create AdfKeyStrokes

Parameters:

keyString

Return:

AdfKeyStroke - A shared AdfKeyStroke instance

_getModifierDisplayString

private static String _getModifierDisplayString(Number modifiers)

Returns the human-readable concatenated value for the modifiers string

Parameters:

modifiers

Return:

String - Human readable string version of the modifiers

getModifiers

public Number getModifiers()

Return:

Number - A bitmask of the modifier keys tht must be pressed simultaneously to match this keystroke

_getModifierString

private static String _getModifierString(Number modifiers)

Returns the concatenated value for the modifiers string

Parameters:

modifiers

Return:

String - Marshallable string version of the modifiers

_getNameFromKeyCode

private static Object _getNameFromKeyCode(Object keyCode)

Returns a canonical key name corresponding to the keycode

Parameters:

keyCode

Return:

Object

_getStringForm

private static String _getStringForm(Object keyCode,
Object modifiers)

Parameters:

keyCode
modifiers

Return:

String - String form of modifiers plus keyCode

Init

protected Object Init(Number keyCode,
Number modifiers,
String stringForm)

Initializes the instance. Subclasses of AdfObject must call their superclass' Init

Parameters:

keyCode	-	Unicode character of key to press
modifiers	-	bitmask of modifiers that must be held down
stringForm	-	Marshallable string version of keyCode and modifiers

Return:

Object

Overrides:

AdfObject.Init()

InitClass

protected static Object InitClass()

Initializes the AdfKeyStroke class

Return:

Object

toMarshalledString

public String toMarshalledString()

Returns a canonical String representation of the AdfKeyStroke object. This canonical representation is used as the value sent across the wire since the server-side AdfKeyStroke class understands how to parse it.

Return:

String - Marshallable String form of modifiers plus keyCode

toString

public Object toString()

Return:

Object

Overrides:

AdfObject.toString()

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD