What is Incisor?
Tutorials
Key Concepts
Reddit
Stack Overflow
Deprecation Schedule

UiKeyboardNavigator()

Object housing functionality that enables for keyboard navigation of this SceneObject's ui-related descendants. Keyboard navigation enables the end-user to press the tab, space, and enter keys to outline and trigger any 'uiKeyboardNavigable' descendants of the SceneObject owning this UiKeyboardNavigator when it is 'in focus' according to 'nc.singularFocusObject'. SceneObjects have a member named "uiKeyboardNavigator", which defaults to undefined, but can be enabled, by calling 'SceneObject.configureUiKeyboardNavigator()'. [NON-INSTANTIABLE] [REQUIREMENT: optional code module - 'extendedUi']

new UiKeyboardNavigator()
IncisorAPI.js, line 1647

MEMBERS

defaultOutlined :SceneObject
IncisorAPI.js, line 1666

If defined, this SceneObject will automatically be outlined when the SceneObject owning this UiKeyboardNavigator is the 'singularFocusObject'.

inheritedTypes :object
IncisorAPI.js, line 1660

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

type :string
IncisorAPI.js, line 1654

Type identifier.

METHODS

dispose()
IncisorAPI.js, line 1679

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

gotoNext(direction (opt))
IncisorAPI.js, line 1674

Instructs to the UiKeyboardNavigator to outline the next, current, or previous UiKeyboardNavigable descendant, based on the 'direction' paramter supplied.

Parameters:
Name Type Attributes Default Description
direction number <optional>
  

Value supplied determining the direction of the navigation. 1 goes to next item, 0 outlines the current item, and -1 outlines the previous item. [DEFAULT: 0]