forked from Jibo-Revival-Group/JiboOs
64 lines
2.6 KiB
JavaScript
64 lines
2.6 KiB
JavaScript
|
/**
|
||
|
|
* Subcomponent identifier.
|
||
|
|
* @name jibo.face.views.TouchInteractive.TYPE
|
||
|
|
* @type {String}
|
||
|
|
* @default 'TouchInteractive'
|
||
|
|
* @readOnly
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Whether interactivity is active or not.
|
||
|
|
* @name jibo.face.views.TouchInteractive.isActive
|
||
|
|
* @type {Boolean}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Object of array of actions, with gesture type as key.
|
||
|
|
* @name jibo.face.views.TouchInteractive._gestureActions
|
||
|
|
* @type {Object.<string, jibo.face.views.ActionData>}
|
||
|
|
* @private
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Destroy
|
||
|
|
* @method jibo.face.views.TouchInteractive#destroy
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Add a {@link jibo.face.views.ActionData}. All actions with will be triggered on triggerActions.
|
||
|
|
* Generally these actions are triggered on a screen press (if a screen press is set up).
|
||
|
|
* @method jibo.face.views.TouchInteractive#addAction
|
||
|
|
* @param {jibo.face.views.ActionData} actionData - The action to be triggered on tap.
|
||
|
|
* @param {boolean} [clearPrevious = false] Flag to determine if we should clear out the existing actions.
|
||
|
|
* @param {boolean} [toFront = false] If `true` adds action to front of actions list, causing it to be called first when actions are triggered.
|
||
|
|
* @param {jibo.face.views.GESTURE} [gesture = 'tap'] Gesture actions are related to.
|
||
|
|
* @returns {jibo.face.views.ActionData} The ActionData added.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns `true` if there are actions associated with given gesture type.
|
||
|
|
* @method jibo.face.views.TouchInteractive#hasActions
|
||
|
|
* @param {jibo.face.views.GESTURE} [gesture = 'tap'] Gesture actions are related to.
|
||
|
|
* @returns {boolean} `true` if there are actions associated with given gesture type.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get actions associated with given gesture type.
|
||
|
|
* @method jibo.face.views.TouchInteractive#getActions
|
||
|
|
* @param {jibo.face.views.GESTURE} [gesture = 'tap'] Gesture actions are related to.
|
||
|
|
* @return {jibo.face.views.ActionData[]} Actions associated with the given gesture type.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Clear all actions associated with given gesture type.
|
||
|
|
* @method jibo.face.views.TouchInteractive#clearActions
|
||
|
|
* @param {jibo.face.views.GESTURE} [gesture = 'tap'] Gesture actions are related to.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Trigger actions associated with given gesture type.
|
||
|
|
* Calls Component or the Component parent's actionHandler for each action.
|
||
|
|
* @method jibo.face.views.TouchInteractive#triggerActions
|
||
|
|
* @param {jibo.face.views.GESTURE} [gesture = 'tap'] Gesture actions are related to.
|
||
|
|
* @return {boolean} `true` if at least one action was triggered.
|
||
|
|
*/
|