Class UINavGroup

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

Index

Constructors

Accessors

Methods

focusFirst focusLast focusNext create

Constructors

`Protected`constructor

new UINavGroup(isInternalConstructor?: boolean): UINavGroup
Parameters
- OptionalisInternalConstructor: boolean
Returns UINavGroup

Overrides FrameworkObject.constructor

Accessors

isLooping

get isLooping(): boolean

Returns boolean

mode

get mode(): EnumValue<UINavigationMode>

Determines the behavior when reaching the end of the navigation group.

Returns EnumValue<UINavigationMode>

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: UIElement): 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?: EnumValue<UINavigationMode>): UINavGroup
Creates a new navigation group.
Parameters
- Optionalmode: EnumValue<UINavigationMode>
  The navigation mode to be used by the group.
Returns UINavGroup