API Docs for: 0.1
Show:

File: /home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/preview-widget.js

/**
 * 
 * A widget for a preview.
 * 
 * @module ScopeJS
 * 
 * @class PreviewWidget
 */
function PreviewWidget(){}

PreviewWidget.prototype = {
/**
* Adds an attribute definition and its value
 * @method add_attribute_value
 * @param key {String} Attribute definition
 * @param value {String}, {Number}, {Object}. The value can be a string, number, object
*/
add_attribute_value: function(key, value) {
},
/**
* Adds an attribute definition using a component mapping
 * @method add_attribute_mapping
 * @param key {String} Attribute definition
 * @param value {String} Value
*/
add_attribute_mapping: function(key, value) {
},
/**
* Adds a widget into expandable widget
 * @method add_widget
 * @param widget {PreviewWidget} The widget that needs to be added
*/
add_widget: function(widget) {
},
/**
* Get the identifier of this widget
 * @method id
 * @return Id {String}
*/
id: function() {
},
/**
* Get type name of this widget
 * @method widget_type
 * @return {String} Widget type
*/
widget_type: function() {
},
/**
* Get the components of this widget
 * @method attribute_mappings
 * @return Dictionary of widget components
*/
attribute_mappings: function() {
},
/**
* Get the attributes of this widget
 * @method attribute_values
 * @return Object corresponding to attributes of this widget
*/
attribute_values: function() {
},
/**
* Get widgets of 'expandable' widget
 * @method widgets
 * @return List of PreviewWidget
*/
widgets: function() {
},
/**
* Get a JSON representation of this widget
 * @method data
 * @return String representation of widget
*/
data: function() {
}
};