Files
JiboOs/docs/rendering/gui/components/ContentButton.js

78 lines
2.4 KiB
JavaScript
Raw Normal View History

2026-03-16 13:53:01 +02:00
/**
* @interface jibo.face.views.ContentButton~ContentButtonOptions
* @extends jibo.face.views.MenuButton~MenuButtonOptions
* @description Interface describing data provided in the config.
* @prop {Boolean} [isVideo] - Flag indicating if the content in the button is video.
* @prop {jibo.face.views.ContentButton.AlbumInfo} [albumInfo] - Information about album shown in the button.
*/
/**
* @interface jibo.face.views.ContentButton~ContentButtonOptions
* @extends jibo.face.views.MenuButton~MenuButtonOptions
* @description Interface describing data provided in the config.
* @prop {Boolean} [isVideo] - Flag indicating if the content in the button is video.
* @prop {jibo.face.views.ContentButton.AlbumInfo} [albumInfo] - Information about album shown in the button.
*/
/**
* Information about album displayed on the button.
* @class AlbumInfo
* @memberof jibo.face.views.ContentButton
*/
/**
* Album title.
* @name jibo.face.views.ContentButton.AlbumInfo#title
* @type {String}
*/
/**
* Number of items in the album.
* @name jibo.face.views.ContentButton.AlbumInfo#length
* @type {Number}
*/
/**
* Content button, extends MenuButton to handle specifics required for displaying photo, video, or
* album thumbnails.
* @class ContentButton
* @extends jibo.face.views.MenuButton
* @memberof jibo.face.views
*/
/**
* The default class identifier.
* Generally used to register the class.
* @name jibo.face.views.ContentButton#DEFAULT_TYPE
* @type {String}
* @private
* @readOnly
*/
/**
* Create a ContentButton from a configuration Object derived from JSON.
* @method jibo.face.views.ContentButton#createFromConfig
* @param {Object} configData Object derived from JSON, must be a specific format refer to examples.
* @returns {jibo.face.views.ContentButton} ContentButton created from the given configuration.
*/
/**
* Assign configuration.
* @method jibo.face.views.ContentButton#assignConfig
* @param {Object} configData - Configuration to apply
*/
/**
* FOR OVERRIDE ONLY. DO NOT CALL.
*
* Destroy.
* @method jibo.face.views.ContentButton#destroy
*/
/**
* FOR OVERRIDE ONLY. DO NOT CALL.
*
* Set up the timeline asset associated with the button.
* @method jibo.face.views.ContentButton#setupTimeline
* @protected
*/