Winter Cardinal UI - v0.442.0 / DControllerFocusImpl

Class: DControllerFocusImpl

Hierarchy

Implements

Table of contents

Constructors

Methods

Constructors

constructor

• new DControllerFocusImpl(): DControllerFocusImpl

Returns

DControllerFocusImpl

Inherited from

utils.EventEmitter.constructor

Methods

addListener

▸ addListener(event, fn, context?): this

Alias method for on

Parameters

Name Type
event string | symbol
fn Function
context? any

Returns

this

Implementation of

DControllerFocus.addListener

Inherited from

utils.EventEmitter.addListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25495

blur

▸ blur(focusable): null | DFocusable

Parameters

Name Type
focusable null | DFocusable

Returns

null | DFocusable

Implementation of

DControllerFocus.blur

Defined in

src/main/typescript/wcardinal/ui/d-controller-focus-impl.ts:36

clear

▸ clear(): null | DFocusable

Returns

null | DFocusable

Implementation of

DControllerFocus.clear

Defined in

src/main/typescript/wcardinal/ui/d-controller-focus-impl.ts:46

emit

▸ emit(event, ...args): boolean

Calls each of the listeners registered for a given event.

Parameters

Name Type Description
event string | symbol The event name.
...args any[] Arguments that are passed to registered listeners

Returns

boolean

true if the event had listeners, else false.

Implementation of

DControllerFocus.emit

Inherited from

utils.EventEmitter.emit

Defined in

node_modules/pixi.js/pixi.js.d.ts:25441

eventNames

▸ eventNames(): (string | symbol)[]

Return an array listing the events for which the emitter has registered listeners.

Returns

(string | symbol)[]

Implementation of

DControllerFocus.eventNames

Inherited from

utils.EventEmitter.eventNames

Defined in

node_modules/pixi.js/pixi.js.d.ts:25415

find

▸ find(target, includesTarget, includesTargetChildren, direction, root?): null | DFocusable

Searches a focusable and returns a firstly-found focusable. If no focusable is found, returns null. The search starts from the given target in the depth-first manner. If the root is given, the search will be limited to the root’s children. The root itself will not be checked. This method assumes the root is the one of the parents of the given target.

Parameters

Name Type Description
target DFocusableMightBe a target where a search starts at
includesTarget boolean true to check the target itself
includesTargetChildren boolean true to check the target’s children
direction boolean true to search in the descending order
root? unknown a root of a search

Returns

null | DFocusable

Implementation of

DControllerFocus.find

Defined in

src/main/typescript/wcardinal/ui/d-controller-focus-impl.ts:74

findNext

▸ findNext(target, includesTarget, includesTargetChildren): null | DFocusable

Parameters

Name Type
target DFocusableMightBe
includesTarget boolean
includesTargetChildren boolean

Returns

null | DFocusable

Defined in

src/main/typescript/wcardinal/ui/d-controller-focus-impl.ts:193

findParent

▸ findParent(mightBeFocusable): null | DFocusable

Returns the closest focusable parent of the specified target. If the specified target is focusable, returns the specified target.

Parameters

Name Type Description
mightBeFocusable null | DFocusableMightBe the node a search starts from

Returns

null | DFocusable

Implementation of

DControllerFocus.findParent

Defined in

src/main/typescript/wcardinal/ui/d-controller-focus-impl.ts:62

findPrevious

▸ findPrevious(target, includesTarget, includesTargetChildren): null | DFocusable

Parameters

Name Type
target DFocusableMightBe
includesTarget boolean
includesTargetChildren boolean

Returns

null | DFocusable

Defined in

src/main/typescript/wcardinal/ui/d-controller-focus-impl.ts:230

focus

▸ focus(focusable): null | DFocusable

Parameters

Name Type
focusable null | DFocusable

Returns

null | DFocusable

Implementation of

DControllerFocus.focus

Defined in

src/main/typescript/wcardinal/ui/d-controller-focus-impl.ts:17

get

▸ get(): null | DFocusable

Returns

null | DFocusable

Implementation of

DControllerFocus.get

Defined in

src/main/typescript/wcardinal/ui/d-controller-focus-impl.ts:58

isFocusReverse

▸ isFocusReverse(target): boolean

Parameters

Name Type
target any

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-controller-focus-impl.ts:288

isFocusRoot

▸ isFocusRoot(target, root): target is DFocusable

Parameters

Name Type
target any
root unknown

Returns

target is DFocusable

Defined in

src/main/typescript/wcardinal/ui/d-controller-focus-impl.ts:281

isFocusable

▸ isFocusable(target): target is DFocusable

Parameters

Name Type
target any

Returns

target is DFocusable

Defined in

src/main/typescript/wcardinal/ui/d-controller-focus-impl.ts:267

isFocusableContainer

▸ isFocusableContainer(target): target is DFocusableContainer

Parameters

Name Type
target any

Returns

target is DFocusableContainer

Defined in

src/main/typescript/wcardinal/ui/d-controller-focus-impl.ts:277

listenerCount

▸ listenerCount(event): number

Return the number of listeners listening to a given event.

Parameters

Name Type Description
event string | symbol The event name.

Returns

number

Implementation of

DControllerFocus.listenerCount

Inherited from

utils.EventEmitter.listenerCount

Defined in

node_modules/pixi.js/pixi.js.d.ts:25432

listeners

▸ listeners(event): Function[]

Return the listeners registered for a given event.

Parameters

Name Type Description
event string | symbol The event name.

Returns

Function[]

Implementation of

DControllerFocus.listeners

Inherited from

utils.EventEmitter.listeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25424

off

▸ off(event, fn?, context?, once?): this

Alias method for removeListener

Parameters

Name Type
event string | symbol
fn? Function
context? any
once? boolean

Returns

this

Implementation of

DControllerFocus.off

Inherited from

utils.EventEmitter.off

Defined in

node_modules/pixi.js/pixi.js.d.ts:25489

on

▸ on(event, fn, context?): this

Add a listener for a given event.

Parameters

Name Type Description
event string | symbol The event name.
fn Function The listener function.
context? any The context to invoke the listener with.

Returns

this

this.

Implementation of

DControllerFocus.on

Inherited from

utils.EventEmitter.on

Defined in

node_modules/pixi.js/pixi.js.d.ts:25452

once

▸ once(event, fn, context?): this

Add a one-time listener for a given event.

Parameters

Name Type Description
event string | symbol The event name.
fn Function The listener function.
context? any The context to invoke the listener with.

Returns

this

this.

Implementation of

DControllerFocus.once

Inherited from

utils.EventEmitter.once

Defined in

node_modules/pixi.js/pixi.js.d.ts:25463

removeAllListeners

▸ removeAllListeners(event?): this

Remove all listeners, or those of the specified event.

Parameters

Name Type Description
event? string | symbol The event name.

Returns

this

this.

Implementation of

DControllerFocus.removeAllListeners

Inherited from

utils.EventEmitter.removeAllListeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25483

removeListener

▸ removeListener(event, fn?, context?, once?): this

Remove the listeners of a given event.

Parameters

Name Type Description
event string | symbol The event name.
fn? Function Only remove the listeners that match this function.
context? any Only remove the listeners that have this context.
once? boolean Only remove one-time listeners.

Returns

this

this.

Implementation of

DControllerFocus.removeListener

Inherited from

utils.EventEmitter.removeListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25475

set

▸ set(focusable, isFocused): null | DFocusable

Parameters

Name Type
focusable null | DFocusable
isFocused boolean

Returns

null | DFocusable

Implementation of

DControllerFocus.set

Defined in

src/main/typescript/wcardinal/ui/d-controller-focus-impl.ts:50

Edit this page.