Default values for widget model attributes

Author: SylvainCorlay

ipywidgets/static/widgets/js/widget.js

@@ -39,6 +39,15 @@ define(["./utils",
     };
 
     var WidgetModel = Backbone.Model.extend({
+
+        defaults: {
+            _model_module: null,
+            _model_name: "WidgetModel",
+            _view_module: "",
+            _view_name: null,
+            msg_throttle: 3
+        },
+
         constructor: function (widget_manager, model_id, comm) {
             /**
              * Constructor
@@ -548,7 +557,11 @@ define(["./utils",
         }
     };
 
-    var DOMWidgetModel = WidgetModel.extend({}, {
+    var DOMWidgetModel = WidgetModel.extend({
+        defaults: _.extend(WidgetModel.prototype.defaults, {
+            layout: undefined,
+        }),
+    }, {
         serializers: _.extend({
             layout: {deserialize: unpack_models},
         }, WidgetModel.serializers),
@@ -843,16 +856,16 @@ define(["./utils",
     var DOMWidgetView = WidgetView.extend(DOMWidgetViewMixin);
 
     var widget = {
-        'unpack_models': unpack_models,
-        'WidgetModel': WidgetModel,
-        'WidgetViewMixin': WidgetViewMixin,
-        'DOMWidgetViewMixin': DOMWidgetViewMixin,
-        'ViewList': ViewList,
-        'DOMWidgetModel': DOMWidgetModel,
+        unpack_models: unpack_models,
+        WidgetModel: WidgetModel,
+        WidgetViewMixin: WidgetViewMixin,
+        DOMWidgetViewMixin: DOMWidgetViewMixin,
+        ViewList: ViewList,
+        DOMWidgetModel: DOMWidgetModel,
 
         // For backwards compatibility.
-        'WidgetView': WidgetView,
-        'DOMWidgetView': DOMWidgetView,
+        WidgetView: WidgetView,
+        DOMWidgetView: DOMWidgetView,
     };
 
     return widget;

ipywidgets/static/widgets/js/widget_bool.js

@@ -7,11 +7,28 @@ if (typeof define !== 'function') { var define = require('./requirejs-shim')(mod
 define([
     "./widget",
     "jquery",
+    "underscore",
     "bootstrap",
-], function(widget, $){
+], function(widget, $, _){
+
+    var BoolModel = widget.DOMWidgetModel.extend({
+        defaults: _.extend(widget.DOMWidgetModel.prototype.defaults, {
+            value: false,
+            description: "",
+            disabled: false,
+            _model_name: "BoolModel"
+        }),
+    });
+
+    var CheckboxModel = BoolModel.extend({
+        defaults: _.extend(BoolModel.prototype.defaults, {
+            _view_name: "CheckboxView",
+            _model_name: "CheckboxModel"
+        }),
+    });
 
     var CheckboxView = widget.DOMWidgetView.extend({
-        render : function(){
+        render: function(){
             /**
              * Called when view is rendered.
              */
@@ -52,7 +69,7 @@ define([
             this.touch();
         },
 
-        update : function(options){
+        update: function(options){
             /**
              * Update the contents of this view
              *
@@ -76,9 +93,18 @@ define([
         },
     });
 
+    var ToggleButtonModel = BoolModel.extend({
+        defaults: _.extend(BoolModel.prototype.defaults, {
+            _view_name: "ToggleButtonView",
+            _model_name: "ToggleButtonModel",
+            tooltip: "",
+            icon: "",
+            button_style: "primary",
+        }),
+    });
 
     var ToggleButtonView = widget.DOMWidgetView.extend({
-        render : function() {
+        render: function() {
             /**
              * Called when view is rendered.
              */
@@ -110,7 +136,7 @@ define([
             this.update_mapped_classes(class_map, 'button_style', previous_trait_value);
         },
 
-        update : function(options){
+        update: function(options){
             /**
              * Update the contents of this view
              *
@@ -152,6 +178,13 @@ define([
         },
     });
 
+    var ValidModel = BoolModel.extend({
+        defaults: _.extend(BoolModel.prototype.defaults, {
+            readout: "Invalid", 
+            _view_name: "ValidView",
+            _model_name: "ValidModel"
+        }),
+    });
 
     var ValidView = widget.DOMWidgetView.extend({
         render: function() {
@@ -162,6 +195,7 @@ define([
             this.listenTo(this.model, "change", this.update, this);
             this.update();
         },
+
         update: function() {
             /**
              * Update the contents of this view
@@ -190,8 +224,12 @@ define([
 
 
     return {
-        'CheckboxView': CheckboxView,
-        'ToggleButtonView': ToggleButtonView,
-        'ValidView': ValidView,
+        BoolModel: BoolModel,
+        CheckboxModel: CheckboxModel,
+        CheckboxView: CheckboxView,
+        ToggleButtonModel: ToggleButtonModel,
+        ToggleButtonView: ToggleButtonView,
+        ValidModel: ValidModel,
+        ValidView: ValidView,
     };
 });

ipywidgets/widgets/widget_bool.py

@@ -22,37 +22,42 @@ def __init__(self, value=None, **kwargs):
             kwargs['value'] = value
         super(_Bool, self).__init__(**kwargs)
 
+    _model_name = Unicode('BoolModel', sync=True)
+
 
 @register('Jupyter.Checkbox')
 class Checkbox(_Bool):
     """Displays a boolean `value` in the form of a checkbox.
 
-       Parameters
-       ----------
-       value : {True,False}
-           value of the checkbox: True-checked, False-unchecked
-       description : str
-	   description displayed next to the checkbox
-"""
+    Parameters
+    ----------
+    value : {True,False}
+       value of the checkbox: True-checked, False-unchecked
+    description : str
+	     description displayed next to the checkbox
+    """
     _view_name = Unicode('CheckboxView', sync=True)
+    _model_name = Unicode('CheckboxModel', sync=True)
 
 
 @register('Jupyter.ToggleButton')
 class ToggleButton(_Bool):
     """Displays a boolean `value` in the form of a toggle button.
 
-       Parameters
-       ----------
-       value : {True,False}
-           value of the toggle button: True-pressed, False-unpressed
-       description : str
-	   description displayed next to the button
-       tooltip: str
-           tooltip caption of the toggle button
-       icon: str
-           font-awesome icon name
-"""
+    Parameters
+    ----------
+    value : {True,False}
+        value of the toggle button: True-pressed, False-unpressed
+    description : str
+	      description displayed next to the button
+    tooltip: str
+        tooltip caption of the toggle button
+    icon: str
+        font-awesome icon name
+    """
     _view_name = Unicode('ToggleButtonView', sync=True)
+    _model_name = Unicode('ToggleButtonModel', sync=True)
+
     tooltip = Unicode(help="Tooltip caption of the toggle button.", sync=True)
     icon = Unicode('', help= "Font-awesome icon.", sync=True)
 
@@ -64,14 +69,15 @@ class ToggleButton(_Bool):
 
 @register('Jupyter.Valid')
 class Valid(_Bool):
-
     """Displays a boolean `value` in the form of a green check (True / valid)
     or a red cross (False / invalid).
 
     Parameters
     ----------
     value: {True,False}
         value of the Valid widget
-"""
-    readout = Unicode(help="Message displayed when the value is False", sync=True)
+    """
+    readout = Unicode('Invalid', help="Message displayed when the value is False", sync=True)
     _view_name = Unicode('ValidView', sync=True)
+    _model_name = Unicode('ValidModel', sync=True)
+