forked from Jibo-Revival-Group/JiboOs
99 lines
2.3 KiB
JavaScript
99 lines
2.3 KiB
JavaScript
/**
|
|
* @description Interface - Configuration values for creating a TextView.
|
|
* @interface jibo.face.views.TextView~TextViewOptions
|
|
* @extends jibo.face.views.View~ViewOptions
|
|
* @prop {string} [text] - Text to show.
|
|
* @prop {PIXI.TextStyle} [style] - Style of the text.
|
|
* @prop {jibo.face.views.Element~DimensionData} [margins] - Margins between edge of screen and text bounds.
|
|
*/
|
|
|
|
/**
|
|
* View designed to display standard text.
|
|
*
|
|
* Takes a simplified JSON configuration.
|
|
* @example
|
|
* {
|
|
* "viewConfig": {
|
|
* "type": "TextView","
|
|
* "id": "text_view_id",
|
|
* "text":"This is a text"
|
|
* }
|
|
* }
|
|
* @class TextView
|
|
* @extends jibo.face.views.View
|
|
* @memberof jibo.face.views
|
|
*/
|
|
|
|
/**
|
|
* Default value for the text style if one's missing.
|
|
* @name jibo.face.views.Label.DEFAULT_STYLE
|
|
* @type {PIXI.TextStyle}
|
|
* @readOnly
|
|
* @private
|
|
*/
|
|
|
|
/**
|
|
* Margin value for X padding on either side of text to edge of screen.
|
|
* @name jibo.face.views.TextView.TEXT_MARGIN_X
|
|
* @type {number}
|
|
* @readOnly
|
|
* @private
|
|
*/
|
|
|
|
/**
|
|
* Margin value for Y padding on either side of text to edge of screen.
|
|
* @name jibo.face.views.TextView.TEXT_MARGIN_Y
|
|
* @type {number}
|
|
* @readOnly
|
|
* @private
|
|
*/
|
|
|
|
/**
|
|
* Object describing the font specification used by `PIXI.Text`.
|
|
* Will be applied to the text on
|
|
* ```
|
|
* fontSize: 100,
|
|
* fontFamily: 'Proxima Nova Soft',
|
|
* fill: '#FFFFFF',
|
|
* fontStyle: 'bold'
|
|
* wordWrap: true,
|
|
* wordWrapWidth: 100,
|
|
* align: 'center'
|
|
* ```
|
|
* @name jibo.face.views.Label#style
|
|
* @type {PIXI.TextStyle}
|
|
*/
|
|
|
|
/**
|
|
* Margins between text and edge of screen.
|
|
* If not specified will use the defaults.
|
|
* @name jibo.face.views.Label#margins
|
|
* @type {DimensionData}
|
|
*/
|
|
|
|
/**
|
|
* Text of TextView label.
|
|
* @name jibo.face.views.TextView#text
|
|
* @public
|
|
* @readOnly
|
|
* @type {String}
|
|
*/
|
|
|
|
/**
|
|
* Text of TextView label.
|
|
* @name jibo.face.views.TextView#text
|
|
* @public
|
|
* @type {String}
|
|
*/
|
|
|
|
/**
|
|
* Label of the TextView.
|
|
* @name jibo.face.views.TextView#label
|
|
* @public
|
|
* @readOnly
|
|
* @type {jibo.face.views.Label}
|
|
*/
|
|
|
|
/**
|
|
* Construct View
|
|
*/ |