forked from Jibo-Revival-Group/JiboOs
60 lines
2.0 KiB
JavaScript
60 lines
2.0 KiB
JavaScript
/**
|
|
* Identifier, same as id of View that ViewState represents.
|
|
* @name jibo.face.views.ViewState#id
|
|
* @type {String}
|
|
*/
|
|
|
|
/**
|
|
* URI to the configuration JSON file for the corresponding view.
|
|
* @name jibo.face.views.ViewState#configPath
|
|
* @type {String}
|
|
*/
|
|
|
|
/**
|
|
* Class name of the corresponding view.
|
|
* @name jibo.face.views.ViewState#viewClassName
|
|
* @type {String}
|
|
*/
|
|
|
|
/**
|
|
* Configuration Objects, generally derived from JSON,
|
|
* that defines corresponding view.
|
|
* @name jibo.face.views.ViewState#viewConfig
|
|
*/
|
|
|
|
/**
|
|
* Array of configuration Objects, generally derived from JSON,
|
|
* that define corresponding view's components.
|
|
* @name jibo.face.views.ViewState#componentConfigs
|
|
* @type {Object[]}
|
|
*/
|
|
|
|
/**
|
|
* Flag to determine whether, when corresponding view is opened,
|
|
* it should pause the view below it.
|
|
* @name jibo.face.views.ViewState#pauseParent
|
|
* @type {boolean}
|
|
* @default false
|
|
*/
|
|
|
|
/**
|
|
* Flag to determine if corresponding view should enact close on swipe down.
|
|
* @name jibo.face.views.ViewState#ignoreSwipeDown
|
|
* @type {boolean}
|
|
* @default false
|
|
*/
|
|
|
|
/**
|
|
* Can pass in the name of the corresponding ViewState class and config if available at construction.
|
|
* @param {String} [viewClassName = 'View'] - Class name of View the ViewState represents.
|
|
* @param {Object} [config] - Configuration Object for the corresponding View, generally derived from JSON.
|
|
* Contains both view and components configurations.
|
|
*/
|
|
|
|
/**
|
|
* Derives separate references to view configuration, component configurations,
|
|
* and View type from the given configuration.
|
|
* @method jibo.face.views.ViewState#applyConfig
|
|
* @param {Object} config Configuration Object for the corresponding View, generally derived from JSON.
|
|
* Contains both view and components configurations.
|
|
*/ |