netzke-basepack 0.3.5 → 0.3.6

data/CHANGELOG

@@ -1,5 +1,15 @@
+v0.3.6
+Netzke-core v0.2.9 compatibility
+Cleaner handling of custom renderers in GridPanel.
+New FormPanel-based PropertyEditor replaces PropertyGrid.
+Xcheckbox and check-column introduced.
+TODO file added.
+Bug fix: in TableEditor, the grid now responses on events also after being reconfigured.
+Bug fix: a couple of IE-related bugs.
+Significant code clean-up.
+
 v0.3.5
-netzke-core v0.2.8 compatibility
+Netzke-core v0.2.8 compatibility
 
 v0.3.4
 Quick tips added to the "tools"

data/Manifest

@@ -1,5 +1,4 @@
 CHANGELOG
-css/basepack.css
 generators/netzke_basepack/netzke_basepack_generator.rb
 generators/netzke_basepack/USAGE
 generators/netzke_form_panel/netzke_form_panel_generator.rb
@@ -15,30 +14,33 @@ lib/netzke/accordion_panel.rb
 lib/netzke/ar_ext.rb
 lib/netzke/basic_app.rb
 lib/netzke/border_layout_panel.rb
+lib/netzke/configuration_tool.rb
 lib/netzke/container.rb
 lib/netzke/db_fields.rb
 lib/netzke/fields_configurator.rb
 lib/netzke/form_panel.rb
 lib/netzke/form_panel_extras/interface.rb
+lib/netzke/form_panel_extras/javascripts/xcheckbox.js
 lib/netzke/form_panel_extras/javascripts/xdatetime.js
 lib/netzke/form_panel_extras/js_builder.rb
 lib/netzke/grid_panel.rb
 lib/netzke/grid_panel_extras/interface.rb
-lib/netzke/grid_panel_extras/javascripts/check_column.js
+lib/netzke/grid_panel_extras/javascripts/check-column.js
 lib/netzke/grid_panel_extras/javascripts/filters.js
 lib/netzke/grid_panel_extras/js_builder.rb
 lib/netzke/panel.rb
-lib/netzke/preference_grid.rb
-lib/netzke/properties_tool.rb
-lib/netzke/property_grid.rb
+lib/netzke/property_editor.rb
+lib/netzke/property_editor_extras/helper_model.rb
 lib/netzke/tab_panel.rb
 lib/netzke/table_editor.rb
+lib/netzke/tree_panel.rb
 lib/netzke/wrapper.rb
 lib/netzke-basepack.rb
 LICENSE
 Manifest
 Rakefile
 README.rdoc
+stylesheets/basepack.css
 tasks/netzke_basepack_tasks.rake
 test/app_root/app/controllers/application.rb
 test/app_root/app/models/book.rb
@@ -82,4 +84,5 @@ test/grid_panel_test.rb
 test/netzke_basepack_test.rb
 test/schema.rb
 test/test_helper.rb
+TODO
 uninstall.rb

data/README.rdoc

@@ -84,4 +84,4 @@ TODO: this part will be covered later
 = Credentials
 Testing done with the help of http://github.com/pluginaweek/plugin_test_helper
 
-Copyright (c) 2008-2009 Sergei Kozlov, released under the GNU GPL license v3
+Copyright (c) 2008-2009 Sergei Kozlov, released under the LGPL 3.0

data/Rakefile

@@ -5,7 +5,7 @@ Echoe.new("netzke-basepack") do |p|
   p.email = "sergei@writelesscode.com"
   p.summary = "Base Netzke widgets - grid, form, tree, and more"
   p.url = "http://writelesscode.com"
-  p.runtime_dependencies = ["searchlogic >=1.6.2", "netzke-core >= 0.2.8"]
+  p.runtime_dependencies = ["searchlogic >=1.6.2", "netzke-core >= 0.2.9"]
   p.development_dependencies = []
   p.test_pattern = 'test/**/*_test.rb'
 

data/TODO

@@ -0,0 +1 @@
+* GridPanel. Reordering of grid columns may lead to unpredictable results when data from an "outdated" table (e.g. open in another browser) gets submitted. A mechanism is needed to submit updated data along with the field names - as hash (as done is FormPanel), *not* as array.

data/javascripts/basepack.js

@@ -57,19 +57,23 @@ Ext.netzke.editors = {
 };
 
 Ext.netzke.renderer = function(renderer, c, config){
-  res = Ext.emptyFn;
-  switch (renderer) {
+  res = null; // null-renderer means "no renderer"
+  
+  if (renderer){
+    switch (renderer) {
 
-    // custom renderers can be later added like this:
-    case 'my_renderer':
-      res = function(value){ return "Not implemented" };
-    break
+      // more renderers can be later added like this:
+      case 'my_renderer':
+        res = function(value){ return "My renderer: " + value };
+      break
 
-    // falls back to Ext.util.Format renderers
-    default:
-      res = Ext.util.Format[renderer]
-    break
+      // falls back to Ext.util.Format renderers
+      default:
+        res = Ext.util.Format[renderer] ? Ext.util.Format[renderer] : function(value){return "Unknown renderer"}
+      break
+    }
   }
+
   return res
 }
 
@@ -109,4 +113,4 @@ Ext.data.RecordArrayReader = Ext.extend(Ext.data.JsonReader, {
     record.json = n;
     return record;
   }
-});
+});

data/lib/app/models/netzke_grid_panel_column.rb

@@ -1,3 +1,5 @@
+require 'netzke/ar_ext'
+
 class NetzkeGridPanelColumn < ActiveRecord::Base
   belongs_to :layout, :class_name => "NetzkeLayout"
   

data/lib/netzke-basepack.rb

@@ -4,11 +4,6 @@ require 'searchlogic'
 
 require 'netzke/ar_ext'
 
-# Default boot config
-Netzke::Base.config.merge!({
-  :grid_panel => {:filters => true}
-}.recursive_merge(Object.const_defined?(:NETZKE_BOOT_CONFIG) ? Object.const_get(:NETZKE_BOOT_CONFIG) : {}))
-
 %w{ models }.each do |dir|
   path = File.join(File.dirname(__FILE__), 'app', dir)
   $LOAD_PATH << path
@@ -19,8 +14,7 @@ end
 # Make this plugin reloadable for easier development
 ActiveSupport::Dependencies.load_once_paths.delete(File.join(File.dirname(__FILE__)))
 
-# Include the javascript
+# Include javascript & styles required by all basepack widgets. 
+# These files will get loaded at the initial load of the framework (along with Ext and Netzke-core).
 Netzke::Base.config[:javascripts] << "#{File.dirname(__FILE__)}/../javascripts/basepack.js"
-
-# Include CSS
-Netzke::Base.config[:css] << "#{File.dirname(__FILE__)}/../css/basepack.css"
+Netzke::Base.config[:stylesheets] << "#{File.dirname(__FILE__)}/../stylesheets/basepack.css"

data/lib/netzke/accordion_panel.rb

@@ -7,7 +7,7 @@ module Netzke
   # * Gets loaded along with the widget that is to be put into the active (expanded) panel (saves us a server request)
   #
   # TODO:
-  # * Stores the last active panel in the persistent_configuration
+  # * Stores the last active panel in persistent_config
   # 
   class AccordionPanel < Base
     #

data/lib/netzke/basic_app.rb

@@ -69,6 +69,17 @@ module Netzke
             JS
   			    :scope => this
           }
+        else
+          res << "->" <<
+          {
+            :text => "Login",
+            :handler => <<-JS.l,
+              function(){
+                window.location = "/login"
+              }
+            JS
+  			    :scope => this
+          }
         end
         res
       end
@@ -76,20 +87,6 @@ module Netzke
       def js_extend_properties
         super.merge({
 
-          :logout => <<-JS.l,
-            function(){
-              window.location = "#{config[:logout_url]}"
-            }
-          JS
-
-          # Work around to fire "appLoaded" event only once
-          :on_after_layout => <<-JS.l,
-            function(){
-              this.un('afterlayout', this.onAfterLayout, this); // avoid multiple calls
-              this.appLoaded();
-            }
-          JS
-
           # Initialize
           :app_loaded => <<-JS.l,
           function(){
@@ -106,9 +103,51 @@ module Netzke
               var lastLoaded = this.initialConfig.widgetToLoad; // passed from the server
               if (lastLoaded) Ext.History.add(lastLoaded);
             }
+            
+            if (this.initialConfig.menu) {this.addMenu(this.initialConfig.menu, this);}
           }
           JS
           
+          :host_menu => <<-JS.l,
+            function(menu, owner){
+              var toolbar = this.getComponent('main-toolbar');
+              if (!this.menus[owner.id]) this.menus[owner.id] = [];
+              Ext.each(menu, function(item) {
+            	  var newMenu = new Ext.Toolbar.Button(item);
+            	  var position = toolbar.items.getCount() - 2;
+            	  position = position < 0 ? 0 : position;
+            	  toolbar.insertButton(position, newMenu);
+            	  this.menus[owner.id].push(newMenu);
+            	}, this);
+          	}
+          JS
+
+          :unhost_menu => <<-JS.l,
+            function(owner){
+              var toolbar = this.getComponent('main-toolbar');
+              if (this.menus[owner.id]) {
+                Ext.each(this.menus[owner.id], function(menu){
+                  toolbar.items.remove(menu); // remove the item from the toolbar
+                  menu.destroy(); // ... and destroy it
+                });
+              }
+            }
+          JS
+
+          :logout => <<-JS.l,
+            function(){
+              window.location = "#{config[:logout_url]}"
+            }
+          JS
+
+          # Work around to fire "appLoaded" event only once
+          :on_after_layout => <<-JS.l,
+            function(){
+              this.un('afterlayout', this.onAfterLayout, this); // avoid multiple calls
+              this.appLoaded();
+            }
+          JS
+
           # Event handler for history change
           :process_history => <<-JS.l,
             function(token){
@@ -120,24 +159,19 @@ module Netzke
             }
           JS
           
-          #
-          # Set this function as the event handler for your menus, e.g.:
-          #
-          #     :menu => {
-          #      :items => [{
-          #        :text => "Books",
-          #        :handler => "this.appLoadWidget".l,
-          #        :widget => 'books', # specify here the name of the widget to be loaded
-          #        :scope => this
-          #      }]
-          #     }
-          #
-          :app_load_widget => <<-JS.l
-          function(menuItem){
-            Ext.History.add(menuItem.widget)
-          }
+          # Loads widget by name
+          :app_load_widget => <<-JS.l,
+            function(name){
+              Ext.History.add(name)
+            }
           JS
 
+          # Loads widget by action
+          :load_widget_by_action => <<-JS.l
+            function(action){
+              this.appLoadWidget(action.widget || action.name)
+            }
+          JS
         })
       end
     end
@@ -175,7 +209,7 @@ module Netzke
     
     # Interface implementation
     def interface_app_get_widget(params)
-      widget = params.delete(:widget)
+      widget = params.delete(:widget).underscore
       persistent_config['last_loaded_widget'] = widget # store the last loaded widget in the persistent storage
       send("#{widget}__get_widget", params)
     end

data/lib/netzke/border_layout_panel.rb

@@ -28,7 +28,6 @@ module Netzke
               
               // A function to access a region widget (even if the widget gets reloaded, the function will work).
               // E.g.: getEastWidget()
-              // I love JavaScript
               this['get'+r.capitalize()+'Widget'] = function(){
                 return this.find('region', r)[0].getWidget()
               }.createDelegate(this)
@@ -86,6 +85,13 @@ module Netzke
     end
     extend ClassMethods
     
+    # default instance-level configuration
+    def initial_config
+      {
+        :persistent_config => true
+      }
+    end
+    
     def initial_aggregatees
       config[:regions] || {}
     end
@@ -109,8 +115,8 @@ module Netzke
     end
   
     def resize_region(params)
-      persistent_config["#{params[:region_name]}_width"] = params[:new_width].to_i if params[:new_width]
-      persistent_config["#{params[:region_name]}_height"] = params[:new_height].to_i if params[:new_height]
+      persistent_config["#{params["region_name"]}_width"] = params["new_width"].to_i if params["new_width"]
+      persistent_config["#{params["region_name"]}_height"] = params["new_height"].to_i if params["new_height"]
       {}
     end
     

data/lib/netzke/{properties_tool.rb → configuration_tool.rb}

@@ -1,8 +1,8 @@
 module Netzke
   #
-  # Include this module into any widget if you want a "Properties" tool button in the top toolbar which will triggger a modal window, which will load the Accordion widgets, which in its turn will contain all the aggregatees specified in "property_widgets" method (*must* be defined)
+  # Include this module into any widget if you want a "Properties" tool button in the top toolbar which will triggger a modal window, which will load the Accordion widgets, which in its turn will contain all the aggregatees specified in "configuration_widgets" method (*must* be defined)
   #
-  module PropertiesTool
+  module ConfigurationTool
     def self.included(base)
       base.extend ClassMethods
       
@@ -16,21 +16,21 @@ module Netzke
         end
       end
 
-      # if you include PropertiesTool, you must define property_widgets method which will returns an array of arrgeratees that will be included in the property window (each in its own tab or accordion pane)
-      raise "property_widgets method undefined" unless base.instance_methods.include?("property_widgets")
+      # if you include ConfigurationTool, you must define configuration_widgets method which will returns an array of arrgeratees that will be included in the property window (each in its own tab or accordion pane)
+      raise "configuration_widgets method undefined" unless base.instance_methods.include?("configuration_widgets")
     end
 
     module ClassMethods
       def js_extend_properties_with_properties
         js_extend_properties_without_properties.merge({
-          :show_config => <<-JS.l
+          :gear => <<-JS.l
             function(){
               var w = new Ext.Window({
                 title:'Config',
                 layout:'fit',
                 modal:true,
-                width:window.innerWidth*.9,
-                height:window.innerHeight*.9,
+                width: Ext.lib.Dom.getViewWidth() *0.9,
+                height: Ext.lib.Dom.getViewHeight() *0.9,
                 closeAction:'destroy',
                 buttons:[{
                   text:'Submit',
@@ -52,10 +52,10 @@ module Netzke
                   if (widget.ownerCt) {
                     widget.ownerCt.loadWidget(widget.initialConfig.interface.getWidget);
                   } else {
-                    this.feedback('Reload current window') // we are embedded directly in HTML
+                    this.feedback('Reload current window'); // we are embedded directly in HTML
                   }
                 }
-              }, this)
+              }, this);
             }
           JS
         })
@@ -64,19 +64,15 @@ module Netzke
 
     def initial_aggregatees_with_properties
       res = initial_aggregatees_without_properties
-      # Add the accordion as aggregatee, which in its turn aggregates widgets from the property_widgets method
-      res.merge!(:properties => {:widget_class_name => 'AccordionPanel', :items => property_widgets, :ext_config => {:title => false}, :no_caching => true, :late_aggregation => true}) if config[:ext_config][:config_tool]
+      # Add the accordion as aggregatee, which in its turn aggregates widgets from the configuration_widgets method
+      res.merge!(:properties => {:widget_class_name => 'AccordionPanel', :items => configuration_widgets, :ext_config => {:title => false}, :no_caching => true, :late_aggregation => true}) if config[:ext_config][:config_tool]
       res
     end
 
     def tools_with_properties
       tools = tools_without_properties
       # Add the toolbutton
-      tools << {
-        :id => 'gear',
-        :qtip => 'Configure',
-        :on => {:click => "showConfig"}
-      } if config[:ext_config][:config_tool]
+      tools << 'gear' if config[:ext_config][:config_tool]
       tools
     end
   

data/lib/netzke/fields_configurator.rb

@@ -23,14 +23,18 @@ module Netzke
     end
     
     def actions
-      super + [{
-        :text => 'Restore defaults', :handler_name => 'loadDefaults', :id => 'defaults'
-      }]
+      super.merge(
+        :defaults => {:text => 'Restore defaults'}
+      )
+    end
+    
+    def bbar
+      super << "-" << "defaults"
     end
     
     def self.js_extend_properties
       super.merge({
-        :load_defaults => <<-JS.l,
+        :defaults => <<-JS.l,
           function(){
             Ext.Msg.confirm('Confirm', 'Are you sure?', function(btn){
               if (btn == 'yes') {

data/lib/netzke/form_panel.rb

@@ -1,33 +1,38 @@
 module Netzke
   class FormPanel < Base
-    # so that some inherited methods would know our real location
-    self.widget_file = __FILE__
-
-    include_extras
+    # Class-level configuration with defaults
+    def self.config
+      set_default_config({
+        :field_manager => "NetzkeFormPanelField",
+      })
+    end
 
+    include Netzke::FormPanelExtras::JsBuilder
+    include Netzke::FormPanelExtras::Interface
+    include Netzke::DbFields # database field operations
+    
+    # extra javascripts
+    js_include %w{ xcheckbox xdatetime }.map{|js| "#{File.dirname(__FILE__)}/form_panel_extras/javascripts/#{js}.js"}
+    
     interface :submit, :load
 
-    include Netzke::DbFields
-    
     def self.widget_type
       :form
     end
     
-    # default configuration
+    # default instance-level configuration
     def initial_config
       {
         :ext_config => {
           :config_tool => true
         },
-        :layout_manager => "NetzkeLayout",
-        :field_manager => "NetzkeFormPanelField",
 
         :persistent_layout => true,
         :persistent_config => true
       }
     end
 
-    def property_widgets
+    def configuration_widgets
       res = []
       res << {
         :name              => 'fields',
@@ -37,21 +42,29 @@ module Netzke
         :layout            => NetzkeLayout.by_widget(id_name),
         :fields_for        => :form
       } if config[:persistent_layout]
+
+      res << {
+        :name               => 'general',
+        :widget_class_name  => "PropertyEditor",
+        :widget_name   => id_name,
+        :ext_config         => {:title => false}
+      }
+      
       res
     end
 
     def tools
-      [{:id => 'refresh', :on => {:click => 'refreshClick'}}]
+      %w{ refresh }
     end
     
     def actions
-      [{
-      #   :text => 'Previous', :handler => 'previous'
-      # },{
-      #   :text => 'Next', :handler => 'next'
-      # },{
-        :text => 'Apply', :handler_name => 'submit', :disabled => !@permissions[:update] && !@permissions[:create], :id => 'apply'
-      }]
+      {
+        :apply => {:text => 'Apply'}
+      }
+    end
+    
+    def bbar
+      persistent_config[:bottom_bar] ||= config[:bbar] == false ? nil : config[:bbar] || %w{ apply }
     end
     
     # get fields from layout manager
@@ -78,23 +91,17 @@ module Netzke
  
     protected
     
-    def layout_manager_class
-      config[:layout_manager].constantize
-    rescue NameError
-      nil
-    end
-    
     def field_manager_class
-      config[:field_manager].constantize
+      self.class.config[:field_manager].constantize
     rescue NameError
       nil
     end
     
-    def available_permissions
-      %w(read update create delete)
-    end
+    # def available_permissions
+    #   %w{ read update }
+    # end
     
-    include PropertiesTool # it will load aggregation with name :properties into a modal window
+    include ConfigurationTool # it will load aggregation with name :properties into a modal window
       
   end
 end