MNavigation

Kind: global class
Extends: Trait
Properties

NameTypeDescription
hasNavigationBoolean

feature flag

Add navigation to a view, which is ’left’, ‘right’, ‘up’, ‘down’ and ‘ok’ methods. It is up to the parent to call the navigation methods.

Important the navigation methods are not callbacks of key events ; a view is never connected directly to the input event bus

left(key, options) ⇒ Boolean

Left-press the view

Kind: instance method of MNavigation
Returns: Boolean - true if the view has something to do (internal navigation), false if the view has nothing to do (out of bound, …)

ParamTypeDescription
keyKey

the key model

optionsobject

the additional options

right(key, options) ⇒ Boolean

Right-press the view

Kind: instance method of MNavigation
Returns: Boolean - true if the view has something to do (internal navigation), false if the view has nothing to do (out of bound, …)

ParamTypeDescription
keyKey

the key model

optionsobject

the additional options

up(key, options) ⇒ Boolean

Up-press the view

Kind: instance method of MNavigation
Returns: Boolean - true if the view has something to do (internal navigation), false if the view has nothing to do (out of bound, …)

ParamTypeDescription
keyKey

the key model

optionsobject

the additional options

down(key, options) ⇒ Boolean

Down-press the view

Kind: instance method of MNavigation
Returns: Boolean - true if the view has something to do (internal navigation), false if the view has nothing to do (out of bound, …)

ParamTypeDescription
keyKey

the key model

optionsobject

the additional options