Class UINavGroup

Contains a set of elements that can be navigated between using keyboard or gamepad buttons (i.e. the 'Tab' button)

Hierarchy

FrameworkObject
- UINavGroup

Index

Constructors

Accessors

Methods

focusFirst focusLast focusNext create

Constructors

`Protected`constructor

new UINavGroup(isInternalConstructor?): UINavGroup
Parameters
- OptionalisInternalConstructor: boolean
Returns UINavGroup
Overrides FrameworkObject.constructor

Accessors

isLooping

get isLooping(): boolean
Returns boolean

mode

get mode(): EnumValue<UINavigationMode, number>
Determines the behavior when reaching the end of the navigation group.

Returns EnumValue<UINavigationMode, number>

Methods

focusFirst

focusFirst(): void
Sets the focus to the first element in the group.

Returns void

focusLast

focusLast(): void
Sets the focus to the last element in the group.

Returns void

focusNext

focusNext(anchor): boolean
Sets the focus to the next element in the navigation order.
Parameters
- anchor: UIElement
  Element relative to which to determine the navigation. This is usually the currently focused element.
Returns boolean
true if the operation was successful, false if reached the end.

`Static`create

create(mode?): UINavGroup
Creates a new navigation group.
Parameters
- Optionalmode: EnumValue<UINavigationMode, number>
  The navigation mode to be used by the group.
Returns UINavGroup