lore 0.4.2

data/gui/form_element.rb

@@ -0,0 +1,676 @@
+
+require('lore/gui/erb_template')
+
+module Lore
+module GUI
+
+  # Form element that can be handled by Cuba::GUI::Form. 
+  class Form_Element 
+  # {{{
+
+    attr_accessor :attribute_table, :attribute_name, :attribute_id, :attribute_range, :attribute_value, :attribute_label, :template, :on_click, :on_change, :id, :mode, :style_class, :template_file, :style
+    
+    def self.for(clause, label, value='', range=nil)
+      attrib = clause.to_s.split('.')
+      if attrib.length == 3 then
+        new(attrib[0..1].join('.'), attrib[2], label, range, value)
+      else
+        new(nil, clause.to_s, label, range, value)
+      end
+    end
+
+    # Expects table name and attribute this element is referring to, as well as 
+    # label to be used for it. 
+    # _attrib_range is an array of option values, e.g. needed for select boxes or radio 
+    # groups, _attrib_value is the elements current value if existing. 
+    def setup(_attrib_table, _attrib_name, _attrib_label, 
+              _attrib_range=nil, _attrib_value='')
+
+      @attribute_table   = _attrib_table
+      @attribute_label   = _attrib_label
+      @attribute_name    = _attrib_name.to_s
+      @attribute_range   = _attrib_range
+      @attribute_value   = _attrib_value
+      @attribute_id      = _attrib_table.to_s.gsub('.','_') + '__' << _attrib_name.to_s
+      @mode              = :mutable
+      @template          = ERB_Template
+      @template_file     = nil
+
+      @style             = ''
+      @style_class       = :lore
+      
+      @id                = ''
+      @on_click          = '' 
+      @on_change         = '' 
+
+      if @attribute_range.instance_of? Range then 
+        @attribute_range = @attribute_range.to_a
+      end
+      
+    end
+    
+    # Set value for this element. 
+    def set_attribute_value(val)
+      @attribute_value = val
+    end
+    
+    # Set style class for element. 
+    def set_attribute_style(style)
+      @style = style
+    end
+
+    # Set mode for this element. 
+    # Modes are :mutable and :readonly. 
+    def set_mode(mode=:mutable)
+      @mode = mode
+    end
+
+    # Returns this element as html string. To be overloaded 
+    # by subclasses. 
+    def string
+      ''
+    end
+    
+    # Returns attribute label as string. 
+    def label
+      if @attribute_label.nil? then '' else @attribute_label end
+    end
+    
+    # Prints string()
+    def print
+      puts string()
+    end
+
+    def onfocus(attribute_id)
+      begin
+        context_help = "Element.addClassName('#{attribute_id.gsub('.','_')}_wrap', 'focussed' ); Element.addClassName('#{attribute_id.gsub('.','_')}', 'focussed' );"
+      rescue ::Exception => e
+        context_help = ''
+      end
+
+      return context_help
+    end
+
+    def onblur(attribute_id)
+      begin
+        context_help = "Element.removeClassName('#{attribute_id.gsub('.','_')}_wrap', 'focussed' ); Element.removeClassName('#{attribute_id.gsub('.','_')}', 'focussed' );"
+      rescue ::Exception => e
+        context_help = ''
+      end
+
+      return context_help
+    end
+
+  end # class }}}
+
+  class Custom_Element < Form_Element
+
+    def initialize(_table, _attrib_name, _attrib_label, _attrib_range=nil, _attrib_value=nil)
+      setup(_table, _attrib_name, _attrib_label, _attrib_range, _attrib_value)
+    end
+
+    # To be overloaded
+    def string
+      'Custom_Element#string not redefined!'
+    end
+
+  end # class Custom_Element
+
+  # Form text element (<input type="text" ...>). 
+  # Subclass of Form_Element. 
+  class Text < Form_Element 
+  # {{{
+
+    def initialize(_table, _attrib_name, _attrib_label, _attrib_range=nil, _attrib_value=nil)
+      setup(_table, _attrib_name, _attrib_label, _attrib_range, _attrib_value)
+      @template_file = 'text.rhtml'
+      @readonly_template_file = 'text_readonly.rhtml'
+    end
+
+    def set_length(length)
+      @length = length
+    end
+
+    def string
+      # to avoid value=""
+      if @attribute_value == '' then @attribute_value = nil end
+
+      if @mode == :mutable then
+        template = @template.new(@template_file)
+
+        if @attribute_table.to_s == '' then
+          name = @attribute_name 
+        else
+          name = @attribute_table + '.' + @attribute_name
+        end
+        if @length.nil? then
+          data = {
+            :id        => @attribute_id, 
+            :class     => @style_class.to_s, 
+            :name      => name, 
+            :value     => @attribute_value, 
+            :style     => @style, 
+            :onfocus   => onfocus("#{@attribute_table.to_s.gsub('.','_')}__#{@attribute_name.to_s}"),
+            :onblur    => onblur("#{@attribute_table.to_s.gsub('.','_')}__#{@attribute_name.to_s}")
+          }
+        else
+          data = {
+            :id        => @attribute_id, 
+            :class     => @style_class.to_s, 
+            :name      => name, 
+            :maxlength => @length, 
+            :value     => @attribute_value, 
+            :style     => @style, 
+            :onfocus   => onfocus("#{@attribute_table.to_s.gsub('.','_')}__#{@attribute_name.to_s}"),
+            :onblur    => onblur("#{@attribute_table.to_s.gsub('.','_')}__#{@attribute_name.to_s}")
+          }
+        end
+
+      elsif @mode == :readonly then
+        template = @template.new(@readonly_template_file)
+        data = { :value => @attribute_value }
+      end
+      template.set_data(:attributes => data)
+      template.string()
+    end
+    
+  end # class }}}
+
+  class Password < Text
+    def initialize(_table, _attrib_name, _attrib_label, _attrib_range=nil, _attrib_value=nil)
+      setup(_table, _attrib_name, _attrib_label, _attrib_range, _attrib_value)
+      @template_file = 'password.rhtml'
+      @readonly_template_file = 'password_readonly.rhtml'
+    end
+  end
+
+  # Form file element (<input type="file" ...>). 
+  # Subclass of Form_Element. 
+  class File < Form_Element 
+  # {{{
+
+    def initialize(_table, _attrib_name, _attrib_label, _attrib_range=nil, _attrib_value=nil)
+      setup(_table, _attrib_name, _attrib_label, _attrib_range, _attrib_value)
+    end
+
+    def string
+      if @mode == :mutable then
+        template = @template.new('file.rhtml')
+      elsif @mode == :readonly then
+        template = @template.new('text_readonly.rhtml')
+      end
+      # to avoid value=""
+      if @attribute_value == '' then @attribute_value = nil end
+      if @mode == :mutable then
+        if @attribute_table.to_s == '' then
+          name = @attribute_name 
+        else
+          name = @attribute_table + '.' + @attribute_name
+        end
+        
+        data = {
+          :id    => @attribute_id, 
+          :class => @style_class.to_s, 
+          :name  => name, 
+          :value => @attribute_value, 
+          :style => @style
+        }
+      elsif @mode == :readonly then
+        data[:value] = @attribute_value 
+      end
+      template.set_data(:attributes => data)
+      template.string()
+    end
+    
+  end # class }}}
+  
+  # Form textarea element (<textarea ...></textarea>). 
+  # Subclass of Form_Element. 
+  class Textarea < Form_Element 
+  # {{{
+
+    @@textarea_count = 0
+
+    def initialize(_table, _attrib_name, _attrib_label, _attrib_range=nil, _attrib_value=nil)
+      setup(_table, _attrib_name, _attrib_label, _attrib_range, _attrib_value)
+    end
+
+    def self.reset_counter
+      @@textarea_count = 0
+    end
+
+    def string
+
+      @@textarea_count += 1
+      @attribute_id = 'lore_textarea_' << @@textarea_count.to_s if @mode == :mutable
+
+      if @attribute_value.nil? then @attribute_value = '' end
+      
+      if @mode == :mutable then
+        template = @template.new('textarea.rhtml')
+      elsif @mode == :readonly then
+        template = @template.new('textarea_readonly.rhtml')
+      end
+    
+      data = {
+        :attributes => {
+          :id      => @attribute_id, 
+          :class   => @style_class.to_s, 
+          :name    => @attribute_table+'.'+@attribute_name, 
+          :style   => @style, 
+          :onfocus => onfocus("#{@attribute_id}"), 
+          :onblur  => onblur("#{@attribute_id}"), 
+        },
+        :value   => @attribute_value
+      }
+#     data[:attributes][:id] = 'lore_textarea_' << @@textarea_count.to_s if @mode == :mutable
+      template.set_data(data)
+      template.string()
+    end
+
+  end # class }}}
+
+  # Form date element (three select boxes for year/month/day). 
+  # Subclass of Form_Element. 
+  class Date < Form_Element 
+  # {{{
+    
+    @@date_field_counter = 1
+
+    def initialize(_table, _attrib_name, _attrib_label, _attrib_range=nil, _attrib_value=nil)
+      setup(_table, _attrib_name, _attrib_label, _attrib_range, _attrib_value)
+    end
+
+    def string
+
+      @@date_field_counter += 1
+      idx = @@date_field_counter.to_s
+      if @mode == :mutable then
+      return '<input class="lore_date" type="text" name="'+@attribute_name+'" value="'+@attribute_value.to_s+'" id="date_field_'+idx+'" /> 
+              <input class="lore_button_varwidth" type="button" value="..." id="date_trigger_'+idx+'" onclick="open_calendar(\'date_field_'+idx+'\',\'date_trigger_'+idx+'\');" />'
+      else 
+        return '<nobr>' << @attribute_value.to_s.gsub(' ','.') + '</nobr>'
+      end
+
+      if @attribute_range.nil? then 
+        @attribute_range = (2005..2008).to_a
+      else 
+        @attribute_range = @attribute_range.to_a
+      end
+      
+      select_year = Select.new(  @attribute_table, 
+                     @attribute_name+'--year', 
+                     nil, 
+                     ['']+@attribute_range, 
+                     @attribute_value.to_s[0..3])
+      select_month = Select.new(  @attribute_table, 
+                     @attribute_name+'--month', 
+                     nil, 
+                     ['']+('01'..'12').to_a, 
+                     @attribute_value.to_s[5..6])
+      select_day = Select.new(  @attribute_table, 
+                     @attribute_name+'--day', 
+                     nil, 
+                     ['']+('01'..'31').to_a, 
+                     @attribute_value.to_s[8..9])
+
+      select_year.set_attribute_value(@attribute_value.to_s[0..3])
+      select_month.set_attribute_value(@attribute_value.to_s[5..6])
+      select_day.set_attribute_value(@attribute_value.to_s[8..9])
+
+      select_year.set_mode(@mode)
+      select_month.set_mode(@mode)
+      select_day.set_mode(@mode)
+
+      return select_day.string+select_month.string+select_year.string
+    end
+
+  end # class }}}
+
+  # Form radio element (<input type="radio" ...>). 
+  # Subclass of Form_Element. 
+  class Radio < Form_Element 
+  # {{{
+
+    def initialize(_table, _attrib_name, _attrib_label, _attrib_range=nil, _attrib_value=nil)
+      setup(_table, _attrib_name, _attrib_label, _attrib_range, _attrib_value)
+
+      if _attrib_label.instance_of? Array then
+        @attribute_label    = _attrib_label[0]
+        @attribute_sublabel = _attrib_label[1]
+      else
+        @attribute_label    = _attrib_label.to_s
+        @attribute_sublabel = nil
+      end
+
+    end # def
+
+    def string
+
+      if @mode == :mutable then 
+        
+        template = @template.new('radio.rhtml')
+        radios = ''
+        radio_index = 0
+        
+        if @attribute_label.nil? or @attribute_label == '' then 
+          label = '' 
+        end
+        
+        if @attribute_value.nil? or @attribute_value == '' then 
+          @attribute_value = @attribute_range[0] 
+        end
+
+        throw 'attribute range must not be nil for Cuba::GUI::Radio instance. ' if @attribute_range.nil?
+        
+        @attribute_range.each { |value|
+        
+          if !@attribute_sublabel.nil? and
+             !@attribute_sublabel[value].nil? then
+            label = @attribute_sublabel[value]
+          else 
+            label = value
+          end
+          label = Lang[label.intern]
+          
+          data = {
+            :id      => @attribute_id, 
+            :class   => @style_class.to_s + '_radio',  
+            :name    => @attribute_table+'.'+@attribute_name, 
+            :onfocus => onfocus("#{@attribute_table.gsub('.','_')}__#{@attribute_name}"), 
+            :onblur  => onblur("#{@attribute_table.gsub('.','_')}__#{@attribute_name}"), 
+            :value   => value,
+            :label   => label
+          }
+          data[:checked] = 'checked' if value == @attribute_value
+
+          template.set_data(:attributes => data)
+          radios += template.string.gsub("\n",'')
+          radio_index += 1
+        }
+        
+      elsif @mode == :readonly then
+        
+        template = @template.new('text_readonly.rhtml')
+        if !@attribute_sublabel.nil? and
+           !@attribute_sublabel[@attribute_value].nil? then
+          label = @attribute_sublabel[@attribute_value]
+        else 
+          label = @attribute_value
+        end
+        label = Lang[label.intern]
+        data = {:value => label}
+        template.set_data(:attributes => data)
+        radios = template.string
+
+      end
+      
+      row_template = @template.new('radio_row.rhtml')
+      row_template.set_data(:radios => radios)
+      row_template.string
+        
+    end # def
+
+  end # class }}}
+
+  # Form checkbox element (<input type="checkbox" ...>). 
+  # Subclass of Form_Element. 
+  class Checkbox < Form_Element 
+  # {{{
+
+    def initialize(_table, _attrib_name, _attrib_label, _attrib_range=nil, _attrib_value=nil)
+      setup(_table, _attrib_name, _attrib_label, _attrib_range, _attrib_value)
+
+      if _attrib_label.instance_of? Array then
+        @attribute_label    = _attrib_label[0]
+        @attribute_sublabel = _attrib_label[1]
+      else
+        @attribute_label    = _attrib_label.to_s
+        @attribute_sublabel = nil
+      end
+      @style_class = :lore_checkbox
+
+    end # def
+
+    def string
+
+      if @mode == :mutable then 
+        
+        template = @template.new('checkbox.rhtml')
+        checkboxes = ''
+        checkbox_index = 0
+        
+        if @attribute_label.nil? or @attribute_label == '' then label = '' end
+
+        @attribute_range.each { |value|
+        
+          if !@attribute_sublabel.nil? and
+             !@attribute_sublabel[value].nil? then
+            label = @attribute_sublabel[value]
+          else 
+          #  Allow label to be empty, don't use value 
+          #  if not set. 
+          #  label = value
+          end
+          
+          if value == @attribute_value then
+            data = { 
+              :id      => @attribute_id, 
+              :class => @style_class.to_s, 
+              :name => @attribute_table+'.'+@attribute_name, 
+              :onfocus => onfocus("#{@attribute_table}__#{@attribute_name}"), 
+              :onblur  => onblur("#{@attribute_table}__#{@attribute_name}"), 
+              :value => value,  
+              :checked => 'checked'
+            }
+          else
+            data = {
+              :id      => @attribute_id, 
+              :class => @style_class.to_s,  
+              :onfocus => onfocus("#{@attribute_table}__#{@attribute_name}"), 
+              :onblur  => onblur("#{@attribute_table}__#{@attribute_name}"), 
+              :name => @attribute_table+'.'+@attribute_name, 
+              :value => value 
+            }
+          end
+          template.set_data(:attributes => data)
+          checkboxes += template.string
+          checkboxes += label.to_s
+          checkbox_index += 1
+        }
+        
+      elsif @mode == :readonly then
+        
+        template = @template.new('text_readonly.rhtml')
+          if !@attribute_sublabel.nil? and
+             !@attribute_sublabel[@attribute_value].nil? then
+            label = @attribute_sublabel[@attribute_value]
+          else 
+            label = @attribute_value
+          end
+        data = {:label => label}
+        template.set_data(data)
+        checkboxes = template.string
+        
+      end
+      
+      row_template = @template.new('checkbox_row.rhtml')
+      row_template.set_data(:checkboxes => checkboxes)
+      row_template.string
+    end # def
+
+  end # class }}}
+
+  # Form select box element (<input type="select" ...><option ...>). 
+  # Subclass of Form_Element. 
+  class Select < Form_Element 
+  # {{{
+    
+    attr_accessor :on_change, :on_blur, :on_focus, :id, :attribute_id
+
+    def initialize(_table, _attrib_name, _attrib_label, _attrib_range=nil, _attrib_value=nil, sublabels=nil)
+      setup(_table, _attrib_name, _attrib_label, _attrib_range, _attrib_value)
+      @labels = sublabels
+    end # def
+    
+    def string
+
+      if !@labels.instance_of? Array 
+        then @labels = @attribute_range 
+      end
+      
+      if @mode == :readonly then
+        
+        template = @template.new('text_readonly.rhtml')
+        index = @attribute_range.index(@attribute_value.to_s)
+        if index.nil? then index = @attribute_range.index(@attribute_value.to_i) end
+
+        label = @labels[index.to_i]
+        data = { :attributes => { :value => label }}
+        
+      elsif @mode == :mutable or @mode == nil then
+
+        @on_focus = onfocus("#{@attribute_table.to_s.gsub('.','_')}__#{@attribute_name.to_s}")
+        @on_blur  = onblur("#{@attribute_table.to_s.gsub('.','_')}__#{@attribute_name.to_s}")
+
+        template = @template.new('select.rhtml')
+        data = {
+          :attributes =>  { 
+#           :id        => @id.to_s, 
+            :id        => @attribute_id, 
+            :class     => @style_class.to_s, 
+            :style   => @style, 
+            :name      => @attribute_name, 
+            :onfocus   => @on_focus.to_s, 
+            :onChange  => @on_change.to_s, 
+            :onblur    => @on_blur.to_s, 
+            :value     => @attribute_value
+          },
+          :range => @attribute_range, 
+          :labels => @labels, 
+          :value => @attribute_value
+        }
+      end
+      template.set_data(data)
+      template.string()
+      
+    end
+
+  end # class }}}
+
+  # This klass builts a select box for instances of a 
+  # given klass. Needed for aggregates, has_a relationships 
+  # etc. 
+  # Subclass of Form_Element. 
+  class Klass_Select < Form_Element 
+  # {{{
+
+    def initialize(_klass, _attrib_table, _attrib_name, _attrib_label)
+      setup(_attrib_table, _attrib_name, _attrib_label, nil, nil)
+      @klass = _klass
+    end 
+
+    def string
+      
+      # predefs: 
+      range         = Array.new
+      sublabels     = Array.new
+      foreign_label = key_string = nil
+      foreign_table = @klass.table_name
+      selectables = @klass.select { |foreign|
+        foreign.where(true)
+        foreign.order_by(@klass.get_primary_keys[foreign_table].first, :asc)
+      }
+      
+      selectables.each { |foreign| 
+#       foreign_label = foreign.get_attribute_values[foreign_table][@klass.get_label.split('.')[-1]]
+        foreign_label = ''
+        if @klass.get_labels.nil? then
+          raise ::Exception.new('Specify a label for has_a - related model klasses (here: ' << @klass.to_s + ') via "use_label".')
+        end
+        @klass.get_labels.each { |label_attrib|
+          foreign_label << foreign.get_attribute_values[foreign_table][label_attrib.split('.')[-1]].to_s << ' '
+        }
+        sublabels.push(foreign_label)
+
+        @klass.get_primary_keys[foreign_table].uniq.each { |keys|
+          key_string = ''
+          keys.each { |key|
+            # concatenate combined primary keys like 'id--id2' -> '3--4'
+            if key_string != '' then key_string += '--' end
+            key_string += foreign.get_attribute_values[foreign_table][key]
+          }
+          range.push(key_string)
+        }
+      }
+
+      select_element = Select.new(@attribute_table, 
+                                  @attribute_name, 
+                                  @attribute_label, 
+                                  range, nil, sublabels)
+      select_element.set_attribute_value(@attribute_value)
+      select_element.set_attribute_style(@style)
+      select_element.set_mode(@mode)
+
+      return select_element.string
+
+    end 
+
+
+  end # class }}}
+  
+  # Form button element (<input type="button" ... />). 
+  # Subclass of Form_Element. 
+  class Button < Form_Element 
+  # {{{
+    attr_accessor :template
+	  
+    def initialize(_type, _value, _style_class=nil)
+      @button_type     = _type
+      @button_label    = _value
+      @attribute_value = _value
+      @style_class     = _style_class
+      @template        = ERB_Template
+    end
+
+    def string
+      
+      template = @template.new('button.rhtml')
+
+      data = {
+        :attributes => { 
+          :id      => @attribute_id, 
+          :class => @style_class.to_s, 
+          :type => @button_type, 
+          :value => @button_label
+        }
+      }
+
+      template.set_data(data)
+      template.string
+      
+    end
+
+  end # class }}}
+
+  # Hidden form element (<input type="hidden" ... />). 
+  # Subclass of Form_Element. 
+  class Hidden < Form_Element 
+  # {{{
+  
+    def initialize(_table, _attrib_name)
+      setup(_table, _attrib_name, '', nil, nil)
+    end
+
+    def string()
+      attrib = @attribute_name.to_s
+      if !@attribute_table.nil? and @attribute_table != '' then
+        attrib = @attribute_table+'.'+attrib
+      end
+      '<input type="hidden" name="'+attrib+'" value="'+@attribute_value.to_s+'" />'
+    end
+    
+  end # class }}}
+  
+end # module
+end # module