Added TextBox submit event

IPython/html/static/notebook/js/widgets/string.js

@@ -1,147 +1,158
 //----------------------------------------------------------------------------
 //  Copyright (C) 2013 The IPython Development Team
 //
 //  Distributed under the terms of the BSD License.  The full license is in
 //  the file COPYING, distributed as part of this software.
 //----------------------------------------------------------------------------
 
 //============================================================================
 // StringWidget
 //============================================================================
 
 /**
  * @module IPython
  * @namespace IPython
  **/
 
 define(["notebook/js/widget"], function(widget_manager){
     var StringWidgetModel = IPython.WidgetModel.extend({});
     widget_manager.register_widget_model('StringWidgetModel', StringWidgetModel);
 
     var LabelView = IPython.WidgetView.extend({
       
         // Called when view is rendered.
         render : function(){
             this.$el = $('<div />');
             this.update(); // Set defaults.
         },
         
         // Handles: Backend -> Frontend Sync
         //          Frontent -> Frontend Sync
         update : function(){
             this.$el.html(this.model.get('value'));
             return IPython.WidgetView.prototype.update.call(this);
         },
         
     });
 
     widget_manager.register_widget_view('LabelView', LabelView);
 
     var TextAreaView = IPython.WidgetView.extend({
       
         // Called when view is rendered.
         render : function(){
             this.$el
                 .addClass('widget-hbox')
                 .html('');
             this.$label = $('<div />')
                 .appendTo(this.$el)
                 .addClass('widget-hlabel')
                 .hide();
             this.$textbox = $('<textarea />')
                 .attr('rows', 5)
                 .addClass('widget-text')
                 .appendTo(this.$el);
             this.$el_to_style = this.$textbox; // Set default element to style
             this.update(); // Set defaults.
         },
         
         // Handles: Backend -> Frontend Sync
         //          Frontent -> Frontend Sync
         update : function(){
             if (!this.user_invoked_update) {
                 this.$textbox.val(this.model.get('value'));
             }
 
             var disabled = this.model.get('disabled');
             this.$textbox.prop('disabled', disabled);
 
             var description = this.model.get('description');
             if (description.length == 0) {
                 this.$label.hide();
             } else {
                 this.$label.html(description);
                 this.$label.show();
             }
             return IPython.WidgetView.prototype.update.call(this);
         },
         
         events: {"keyup textarea" : "handleChanging",
                 "paste textarea" : "handleChanging",
                 "cut textarea" : "handleChanging"},
         
         // Handles and validates user input.
         handleChanging: function(e) { 
             this.user_invoked_update = true;
             this.model.set('value', e.target.value);
             this.model.update_other_views(this);
             this.user_invoked_update = false;
         },
     });
 
     widget_manager.register_widget_view('TextAreaView', TextAreaView);
 
     var TextBoxView = IPython.WidgetView.extend({
       
         // Called when view is rendered.
         render : function(){
             this.$el
                 .addClass('widget-hbox-single')
                 .html('');
             this.$label = $('<div />')
                 .addClass('widget-hlabel')
                 .appendTo(this.$el)
                 .hide();
             this.$textbox = $('<input type="text" />')
                 .addClass('input')
                 .addClass('widget-text')
                 .appendTo(this.$el);
             this.$el_to_style = this.$textbox; // Set default element to style
             this.update(); // Set defaults.
         },
         
         // Handles: Backend -> Frontend Sync
         //          Frontent -> Frontend Sync
         update : function(){
             if (!this.user_invoked_update) {
                 this.$textbox.val(this.model.get('value'));
             }
 
             var disabled = this.model.get('disabled');
             this.$textbox.prop('disabled', disabled);
 
             var description = this.model.get('description');
             if (description.length == 0) {
                 this.$label.hide();
             } else {
                 this.$label.html(description);
                 this.$label.show();
             }
             return IPython.WidgetView.prototype.update.call(this);
         },
         
         events: {"keyup input" : "handleChanging",
                 "paste input" : "handleChanging",
-                "cut input" : "handleChanging"},
+                "cut input" : "handleChanging",
+                "keypress input" : "handleKeypress"},
         
         // Handles and validates user input.
         handleChanging: function(e) { 
             this.user_invoked_update = true;
             this.model.set('value', e.target.value);
             this.model.update_other_views(this);
             this.user_invoked_update = false;
         },
+        
+        // Handles text submition
+        handleKeypress: function(e) { 
+            if (e.keyCode == 13) { // Return key
+                this.user_invoked_update = true;
+                this.model.set('submits', this.model.get('submits') + 1);
+                this.model.update_other_views(this);
+                this.user_invoked_update = false;
+            }
+        },
     });
 
     widget_manager.register_widget_view('TextBoxView', TextBoxView);
 });

IPython/html/widgets/widget_string.py

@@ -1,30 +1,79
 """StringWidget class.  
 
 Represents a unicode string using a widget.
 """
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
+import inspect
+import types
+
 from .widget import Widget
-from IPython.utils.traitlets import Unicode, Bool, List
+from IPython.utils.traitlets import Unicode, Bool, List, Int
 
 #-----------------------------------------------------------------------------
 # Classes
 #-----------------------------------------------------------------------------
 class StringWidget(Widget):
     target_name = Unicode('StringWidgetModel')
     default_view_name = Unicode('TextBoxView')
 
     # Keys
-    _keys = ['value', 'disabled', 'description']
+    _keys = ['value', 'disabled', 'description', 'submits']
     value = Unicode(help="String value")
     disabled = Bool(False, help="Enable or disable user changes")
     description = Unicode(help="Description of the value this widget represents")
+    submits = Int(0, help="Used to capture and fire submission ")
+
+
+    def __init__(self, **kwargs):
+        super(StringWidget, self).__init__(**kwargs)
+        self._submission_callbacks = []
+
+
+    def on_submit(self, callback, remove=False):
+        """Register a callback to handle text submission (triggered when the 
+        user clicks enter).
+
+        Parameters
+        callback: Method handle
+            Function to be called when the text has been submitted.  Function
+            can have two possible signatures:
+            callback()
+            callback(sender)
+        remove: bool (optional)
+            Whether or not to unregister the callback"""
+        if remove and callback in self._submission_callbacks:
+            self._submission_callbacks.remove(callback)
+        elif not remove and not callback in self._submission_callbacks:
+            self._submission_callbacks.append(callback)
+
+
+    def _submits_changed(self, name, old_value, new_value):
+        """Handles when a string widget view is submitted."""
+        if new_value > old_value:
+            for handler in self._submission_callbacks:
+                if callable(handler):
+                    argspec = inspect.getargspec(handler)
+                    nargs = len(argspec[0])
+
+                    # Bound methods have an additional 'self' argument
+                    if isinstance(handler, types.MethodType):
+                        nargs -= 1
+
+                    # Call the callback
+                    if nargs == 0:
+                        handler()
+                    elif nargs == 1:
+                        handler(self)
+                    else:
+                        raise TypeError('StringWidget submit callback must ' \
+                            'accept 0 or 1 arguments.')