MEMBERS

anyKeyTriggers :boolean

IncisorAPI.js, line 1715

Flag determining if any key triggers the currently outlined UiKeyboardNavigable item. Standard UiKeyboardNavigable items are triggered by the "Enter" key and "Spacebar" key, when this flag is true, any key will trigger. Since the triggering keyboard event is sent through to the UiKeyboardNavigable item's 'trigger' callback, further costumizations can be added to the triggering key within the item itself (for example certain keys can be ignored etc...).

Default Value:

• false

defaultOutlined :SceneObject

IncisorAPI.js, line 1722

Optional SceneObject that will automatically be outlined the first time the owner of this UiKeyboardNavigation becomes the 'singularFocusObject'.

inheritedTypes :object

IncisorAPI.js, line 1704

Dictionary object listing all of the types this object is compatible with.

type :string

IncisorAPI.js, line 1698

Type identifier.

METHODS

addSetOutlineCallback(callbackOwner, callbackName)

IncisorAPI.js, line 1731

Adds a callback that occurs whenever this UiKeyboardNavigable item is in need of outlining or unoutlining. A boolean indicating the outline status is sent to the callback as its first parameter.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the callback function that occurs whenever this UiKeyboardNavigable item is in need of outlining or unoutlining.
callbackName	string			The name of the callback function that occurs whenever this UiKeyboardNavigable item is in need of outlining or unoutlining.

addTriggerCallback(callbackOwner, callbackName)

IncisorAPI.js, line 1746

Adds a callback that occurs whenever this UiKeyboardNavigable item triggered via the enter key or the space bar. The triggering browser-generated event is sent to the callback as its first parameter.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the callback function that occurs whenever this UiKeyboardNavigable item triggered via the enter key or the space bar.
callbackName	string			The name of the callback function that occurs whenever this UiKeyboardNavigable item triggered via the enter key or the space bar.

dispose()

IncisorAPI.js, line 1758

Disposes this UiKeyboardNavigable, disabling keyboard navigation for the SceneObject owning it, and freeing object for garbage collection.

removeSetOutlineCallback(callbackOwner, callbackName)

IncisorAPI.js, line 1738

Removes the given setOutline callback.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the callback to be removed.
callbackName	string			The name of the callback to be removed.

removeTriggerCallback(callbackOwner, callbackName)

IncisorAPI.js, line 1753

Removes the given trigger callback.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the callback to be removed.
callbackName	string			The name of the callback to be removed.