Comments for UI elements added

epam · Nov 13, 2013 · de1bfea · de1bfea
1 parent 313cb8a
commit de1bfea
Show file tree

Hide file tree

Showing 9 changed files with 174 additions and 131 deletions.
diff --git a/js/xf.js b/js/xf.js
diff --git a/js/xf.min.js b/js/xf.min.js
diff --git a/xf/ui/xf.ui.header.js b/xf/ui/xf.ui.header.js
@@ -14,12 +14,13 @@
                 return;
             }
 
-            // detect if we have title
+            // Detect if we have title
             var headerTitle = jQHeader.find('h1');
             if (headerTitle.length > 0) {
                 headerTitle.addClass('xf-header-title');
             }
 
+            // Set up options
             options.id = options.id || XF.utils.uniqueID();
             options.title = options.title || '';
             options.html = jQHeader.html();
@@ -28,10 +29,12 @@
             var parentPages = $(this.selector).parents('.xf-page'),
                 siblingPages = $(this.selector).siblings('.xf-page');
 
+            // Add additional class for parent node
             if (!_.isEmpty(parentPages) && options.isFixed) {
                 parentPages.addClass('xf-has-header');
             }
 
+            // Add additional class for siblings
             if (!_.isEmpty(siblingPages)) {
                 siblingPages.addClass('xf-has-header');
             }

diff --git a/xf/ui/xf.ui.list.js b/xf/ui/xf.ui.list.js
@@ -61,11 +61,13 @@
                 );
             });
 
-            // detect headers inside of list
+            // Detect headers inside of list and add class
             listItems.find('h1, h2, h3, h4, h5, h6').addClass('xf-li-header');
 
+            // Detect paragraphs inside of list and add class
             listItems.find('p').addClass('xf-li-desc');
 
+            // Detect if list item is static
             listItems.filter('.xf-li-static').each(function (){
                 $(this).wrapInner('<div class=xf-li-wrap />');
             });
@@ -80,7 +82,7 @@
                     class_ += ' xf-li-' + role;
                 }
 
-                // use `class_` instead of `class` beacuse of IE <=8 has problems
+                // Use `class_` instead of `class` beacuse of IE <=8 has problems
                 listItemsScope.push({'html': html, 'class_': class_, 'id': id});
             });
 

diff --git a/xf/ui/xf.ui.loader.js b/xf/ui/xf.ui.loader.js
@@ -22,6 +22,7 @@
                 idStack = XF.ui.checkInIsset('loader'),
                 newId = false;
 
+            // Check if locader with the same ID was created before
             for (var i in idStack) {
 
                 if (newId) {
@@ -33,6 +34,7 @@
                 }
             }
 
+            // If 'no', add new ID to the stack
             if (!newId) {
                 XF.ui.issetElements.push({type : 'loader', id : id});
             }
@@ -46,13 +48,13 @@
             return jqLoader;
         },
 
-        // show loader or create newone and show it
+        // Show loader or create newone and show it
         show : function (jqLoader) {
             jqLoader = jqLoader || this.create();
             jqLoader.show();
         },
 
-        // hide loader or hide all
+        // Hide loader or hide all
         hide : function (jqLoader) {
             jqLoader = jqLoader || null;
             if (jqLoader === null) {
@@ -62,13 +64,13 @@
             }
         },
 
-        // remove loader's dom-element
+        // Remove loader's dom-element
         remove : function (jqLoader) {
             jqLoader.detach();
             XF.ui.removeFromIsset('popup', jqLoader.attr('id'));
         },
 
-        //add new loader to the page
+        // Add new loader to the page
         create : function () {
             var jqLoader = $('<div class="xf-loader" data-role="loader"><div class="xf-loader-content"><div class="loading"></div></div></div>');
             XF.device.getViewport().append(jqLoader);

diff --git a/xf/ui/xf.ui.popup.js b/xf/ui/xf.ui.popup.js
@@ -190,36 +190,40 @@
 
             jQButton.html(buttonDescr.text);
 
+            //Set button's attributes
+            // Icon
             if (buttonDescr.icon && buttonDescr.icon != '') {
                 attrs['data-icon'] = buttonDescr.icon;
             };
 
+            // Icon position
             if (buttonDescr.iconpos && buttonDescr.iconpos != '') {
                 attrs['data-iconpos'] = buttonDescr.iconpos;
             };
 
+            // Button size
             if (buttonDescr.small && buttonDescr.small != '') {
                 attrs['data-small'] = buttonDescr.small;
             };
 
+            // Button appearance 
             if (buttonDescr.appearance && buttonDescr.appearance != '') {
                 attrs['data-appearance'] = buttonDescr.appearance;
             };
 
+            // Button is special or not
             if (buttonDescr.special && buttonDescr.special != '') {
                 attrs['data-special'] = buttonDescr.special;
             };
 
+            // Button is 'alert' or not
             if (buttonDescr.alert && buttonDescr.alert != '') {
                 attrs['data-alert'] = buttonDescr.alert;
             };
 
-            if (_.isFunction(buttonDescr.handler)) {
-                jQButton.click(buttonDescr.handler)
-            };
-
             jQButton.attr(attrs);
 
+            // Set function for button pressed
             if (_.isFunction(buttonDescr.handler)) {
                 jQButton.on('tap', buttonDescr.handler);
             };

diff --git a/xf/ui/xf.ui.scrollable.js b/xf/ui/xf.ui.scrollable.js
@@ -1,8 +1,6 @@
 
     /**
-     Adds scrolling functionality
-     @param scrollable DOM Object
-     @private
+     Add scrolling functionality
      */
     XF.ui.scrollable = {
 
@@ -21,7 +19,7 @@
 
             var children = jQScrollable.children();
 
-            // always create wrapper
+            // Always create wrapper
             if (children.length == 1 && false) {
                 children.addClass('xf-scrollable-content');
             } else {
@@ -39,6 +37,7 @@
                 jQScrollable.attr({'id':wrapperId});
             }
 
+            // Use iScroll
             var ISItem = jQScrollable.data('iscroll', new iScroll(wrapperId));
             var wrapperChanged = false;
 
@@ -59,6 +58,7 @@
                 }
             };
 
+            // Bind hadlers to the scrollable element
             var bindHanlders = function () {
                 $('#' + wrapperId + ' *')
                     .bind('detach', needRefreshIScroll)

diff --git a/xf/ui/xf.ui.tabs.js b/xf/ui/xf.ui.tabs.js
@@ -1,11 +1,10 @@
 
     /**
      Enhances footers view
-     @param footer DOM Object
-     @private
      */
     XF.ui.tabs = {
 
+        // Selectors will be used to detect tabs' element on the page
         selector : '[data-role=tabs]',
 
         render : function (tabs, options) {
@@ -26,7 +25,8 @@
             });
 
             options.tabs = options.tabs || [];
-
+
+            // Detect buttons and count rows
             var buttons = jQTabs.find(XF.ui.button.selector);
             options.rowCount = Math.ceil(buttons.length / options.tabsperrow);
             options.tabsClass = options.tabsclass || '';
@@ -36,6 +36,7 @@
                 lastRowSize = options.tabsperrow;
             }
 
+            // Position buttons in rows
             for (var i = 0; i < buttons.length; ++i){
                 var tab = buttons.eq(i),
                     x = i + 1,
@@ -76,6 +77,7 @@
                 options.tabs.push(tabOpts);
             }
 
+            // Underscore template for tabs
             var _template = _.template(
                 '<ul class="xf-tabs">'
                 + '<% _.each(tabs, function(tab) { %>'
@@ -90,11 +92,13 @@
 
             jQTabs.html(_template(options));
 
+            // Add tab selection' handler to buttons
             jQTabs.find('a').on('tap', function () {
                XF.ui.tabs.selectTab(jQTabs, $(this));
             });
         },
 
+        // Method to show appropriate tab
         selectTab : function (parent, el) {
             parent.find('a').removeClass('xf-tabs-button-active');
             el.addClass('xf-tabs-button-active');