Class: Wice::GridRenderer

Inherits:
Object show all
Includes:
ActionView::Helpers::AssetTagHelper, ActionView::Helpers::CaptureHelper, ActionView::Helpers::JavaScriptHelper, ActionView::Helpers::TagHelper, ActionView::Helpers::TextHelper, Enumerable
Defined in:
lib/grid_renderer.rb

Constant Summary collapse

@@order_parameter_name = 
"order"
@@order_direction_parameter_name = 
"order_direction"
@@page_parameter_name = 
"page"

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Enumerable

#all_items_are_of_class

Constructor Details

#initialize(grid, view) ⇒ GridRenderer

:nodoc:



25
26
27
28
29
30
31
32
 
# File 'lib/grid_renderer.rb', line 25

def initialize(grid, view)  #:nodoc:
  @grid = grid
  @grid.renderer = self
  @columns = []
  @columns_table = {}
  @action_column_present = false
  @view = view
end

Instance Attribute Details

#after_row_handler ⇒ Object (readonly)

Returns the value of attribute after_row_handler.



12
13
14
 
# File 'lib/grid_renderer.rb', line 12

def after_row_handler
  @after_row_handler
end

#before_row_handler ⇒ Object (readonly)

Returns the value of attribute before_row_handler.



13
14
15
 
# File 'lib/grid_renderer.rb', line 13

def before_row_handler
  @before_row_handler
end

#blank_slate_handler ⇒ Object (readonly)

Returns the value of attribute blank_slate_handler.



14
15
16
 
# File 'lib/grid_renderer.rb', line 14

def blank_slate_handler
  @blank_slate_handler
end

#csv_export_icon_present ⇒ Object

Returns the value of attribute csv_export_icon_present.



19
20
21
 
# File 'lib/grid_renderer.rb', line 19

def csv_export_icon_present
  @csv_export_icon_present
end

#erb_mode ⇒ Object

Returns the value of attribute erb_mode.



17
18
19
 
# File 'lib/grid_renderer.rb', line 17

def erb_mode
  @erb_mode
end

#grid ⇒ Object (readonly)

Returns the value of attribute grid.



16
17
18
 
# File 'lib/grid_renderer.rb', line 16

def grid
  @grid
end

#last_row_handler ⇒ Object (readonly)

Returns the value of attribute last_row_handler.



15
16
17
 
# File 'lib/grid_renderer.rb', line 15

def last_row_handler
  @last_row_handler
end

#page_parameter_name ⇒ Object (readonly)

Returns the value of attribute page_parameter_name.



11
12
13
 
# File 'lib/grid_renderer.rb', line 11

def page_parameter_name
  @page_parameter_name
end

#reset_button_present ⇒ Object

Returns the value of attribute reset_button_present.



19
20
21
 
# File 'lib/grid_renderer.rb', line 19

def reset_button_present
  @reset_button_present
end

#show_hide_button_present ⇒ Object

Returns the value of attribute show_hide_button_present.



19
20
21
 
# File 'lib/grid_renderer.rb', line 19

def show_hide_button_present
  @show_hide_button_present
end

#submit_button_present ⇒ Object

Returns the value of attribute submit_button_present.



19
20
21
 
# File 'lib/grid_renderer.rb', line 19

def submit_button_present
  @submit_button_present
end

Instance Method Details

#[](k) ⇒ Object

:nodoc:



48
49
50
 
# File 'lib/grid_renderer.rb', line 48

def [](k)  #:nodoc:
  @columns_table[k]
end

#action_column(opts = {}) ⇒ Object

Adds a column with checkboxes for each record. Useful for actions with multiple records, for example, deleting selected records. Please note that action_column only creates the checkboxes and the ‘Select All’ and ‘Deselect All’ buttons, and the form itelf as well as processing the parameters should be taken care of by the application code.

  • :param_name - The name of the HTTP parameter. The complete HTTP parameter is "#{grid_name}[#{param_name}][]". The default param_name is ‘selected’.

  • :td_html_attrs - a hash of HTML attributes to be included into the td tag.

  • :select_all_buttons - show/hide buttons ‘Select All’ and ‘Deselect All’ in the column header. The default is true.

  • :object_property - a method used to obtain the value for the HTTP parameter. The default is id.



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/grid_renderer.rb', line 148

def action_column(opts = {})

  if @action_column_present
    raise Wice::WiceGridException.new('There can be only one action column in a WiceGrid')
  end

  options = {
    :param_name     => :selected,
    :td_html_attrs  => {},
    :select_all_buttons => true,
    :object_property => :id
  }

  opts.assert_valid_keys(options.keys)
  options.merge!(opts)
  @action_column_present = true
  @columns << ActionViewColumn.new(@grid, options[:td_html_attrs], options[:param_name],
        options[:select_all_buttons], options[:object_property], @view)
end

#add_column(vc) ⇒ Object

:nodoc:



43
44
45
46
 
# File 'lib/grid_renderer.rb', line 43

def add_column(vc)  #:nodoc:
  @columns_table[vc.fully_qualified_attribute_name] = vc if vc.attribute_name
  @columns << vc
end

#after_row(&block) ⇒ Object

Can be used to add HTML code (another row, for example) right after each grid row. Nothing is added if the block return false or nil.



401
402
403
 
# File 'lib/grid_renderer.rb', line 401

def after_row(&block)
  @after_row_handler = block
end

#base_link_for_filter(controller, extra_parameters = {}) ⇒ Object

:nodoc:



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/grid_renderer.rb', line 454

def base_link_for_filter(controller, extra_parameters = {})   #:nodoc:
  new_params = controller.params.deep_clone_yl
  new_params.merge!(extra_parameters)

  if new_params[@grid.name]
    new_params[@grid.name].delete(:page) # we reset paging here
    new_params[@grid.name].delete(:f)    # no filter for the base url
    new_params[@grid.name].delete(:foc)  # nullify the focus
    new_params[@grid.name].delete(:q)    # and no request for the saved query
  end

  new_params[:only_path] = false
  base_link_with_pp_info = controller.url_for(new_params).gsub(/\?+$/,'')

  if new_params[@grid.name]
    new_params[@grid.name].delete(:pp)    # and reset back to pagination if show all mode is on
  end
  [base_link_with_pp_info, controller.url_for(new_params).gsub(/\?+$/,'')]
end

#before_row(&block) ⇒ Object

Can be used to add HTML code (another row, for example) right before each grid row. Nothing is added if the block return false or nil.



407
408
409
 
# File 'lib/grid_renderer.rb', line 407

def before_row(&block)
  @before_row_handler = block
end

#blank_slate(opts = nil, &block) ⇒ Object

The output of the block submitted to blank_slate is rendered instead of the whole grid if no filters are active and there are no records to render. In addition to the block style two other variants are accepted:

  • g.blank_slate "some text to be rendered"

  • g.blank_slate :partial => "partial_name"



421
422
423
424
425
426
427
428
429
 
# File 'lib/grid_renderer.rb', line 421

def blank_slate(opts = nil, &block)
  if (opts.is_a?(Hash) && opts.has_key?(:partial) && block.nil?) || (opts.is_a?(String) && block.nil?)
    @blank_slate_handler = opts
  elsif opts.nil? && block
    @blank_slate_handler = block
  else
    raise WiceGridArgumentError.new("blank_slate accepts only a string, a block, or :template => 'path_to_template' ")
  end
end

#column(opts = {}, &block) ⇒ Object

Defines everything related to a column in a grid - column name, filtering, rendering cells, etc.

column is only used inside the block of the grid method. See documentation for the grid method for more details.

The only parameter is a hash of options. None of them is optional. If no options are supplied, the result will be a column with no name, no filtering and no sorting.

  • :column_name - Name of the column.

  • :td_html_attrs - a hash of HTML attributes to be included into the td tag.

  • :class - a shortcut for :td_html_attrs => {:class => 'css_class'}

  • :attribute_name - name of a database column (which normally correspond to a model attribute with the same name). By default the field is assumed to belong to the default table (see documentation for the initialize_grid method). Parameter :model_class allows to specify another table. Presence of this parameter

    • adds sorting capabilities by this field

    • automatically creates a filter based on the type of the field unless parameter :no_filter is set to true. The following filters exist for the following types:

      • string - a text field

      • integer and float - two text fields to specify the range. Both limits or only one can be specified

      • boolean - a dropdown list with ‘yes’, ‘no’, or ‘-’. These labels can be changed in lib/wice_grid_config.rb.

      • date - two sets of standard date dropdown lists so specify the time range.

      • datetime - two sets of standard datetime dropdown lists so specify the time range. This filter is far from being user-friendly due to the number of dropdown lists.

  • :no_filter - Turns off filters even if :attribute_name is specified. This is needed if sorting is required while filters are not.

  • :allow_ordering - Enable/disable ordering links in the column titles. The default is true (i.e. if :attribute_name is defined, ordering is enabled)

  • :model_class - Name of the model class to which :attribute_name belongs to if this is not the main table.

  • :table_alias - In case there are two joined assocations both referring to the same table, ActiveRecord constructs a query where the second join provides an alias for the joined table. Setting :table_alias to this alias will enable WiceGrid to order and filter by columns belonging to different associatiations but originating from the same table without confusion. See README for an example.

  • :custom_filter - Allows to construct a custom dropdown filter. Depending on the value of :custom_filter different modes are available:

    • array of strings and/or numbers - this is a direct definition of possible values of the dropdown. Every item will be used both as the value of the select option and as its label.

    • Array of two-element arrays - Every first item of the two-element array is used for the label of the select option while the second element is the value of the select option

    • Hash - The keys of the hash become the labels of the generated dropdown list, while the values will be values of options of the dropdown list:

    • :auto - a powerful option which populates the dropdown list with all unique values of the field specified by :attribute_name and :model_class. :attribute_name throughout all pages. In other words, this runs an SQL query without offset and limit clauses and with distinct(table.field) instead of distinct(*)

    • any other symbol name (method name) - The dropdown list is populated by all unique value returned by the method with this name sent to all ActiveRecord objects throughout all pages. The main difference from :auto is that this method does not have to be a field in the result set, it is just some value computed in the method after the database call and ActiveRecord instantiation.

      But here lies the major drawback - this mode requires additional query without offset and limit clauses to instantiate all ActiveRecord objects, and performance-wise it brings all the advantages of pagination to nothing. Thus, memory- and performance-wise this can be really bad for some queries and tables and should be used with care.

      If the method returns a atomic value like a string or an integer, it is used for both the value and the label of the select option element. However, if the retuned value is a two element array, the first element is used for the option label and the second - for the value. Read more in README, section ‘Custom dropdown filters’

    • An array of symbols (method names) - similar to the mode with a single symbol name. The first method name is sent to the ActiveRecord object if it responds to this method, the second method name is sent to the returned value unless it is nil, and so on. In other words, a single symbol mode is a case of an array of symbols where the array contains just one element. Thus the warning about the single method name mode applies here as well.

      If the last method returns a atomic value like a string or an integer, it is used for both the value and the label of the select option element. However, if the retuned value is a two element array, the first element is used for the option label and the second - for the value. Read more in README, section ‘Custom dropdown filters’

  • :boolean_filter_true_label - overrides the label for true in the boolean filter (wice_grid.boolean_filter_true_label in wice_grid.yml).

  • :boolean_filter_false_label - overrides the label for false in the boolean filter (wice_grid.boolean_filter_false_label in wice_grid.yml).

  • :allow_multiple_selection - enables or disables switching between single and multiple selection modes for custom dropdown boxes. true by default (see ALLOW_MULTIPLE_SELECTION in the configuration file).

  • :filter_all_label - overrides the default value for BOOLEAN_FILTER_FALSE_LABEL (‘--’) in the config. Has effect in a column with a boolean filter or a custom filter.

  • :detach_with_id - allows to detach the filter and render it after or before the grid with the grid_filter helper. The value is an arbitrary unique identifier of the filter. Read section ‘Detached Filters’ in README for details. Has effect in a column with a boolean filter or a custom filter.

  • :in_csv - When CSV export is enabled, all columns are included into the export. Setting :in_csv to false will prohibit the column from inclusion into the export.

  • :in_html - When CSV export is enabled and it is needed to use a column for CSV export only and ignore it in HTML, set this parameter to false.

  • :helper_style - Changes the flavor of Date and DateTime filters. The values are:

    • :standard - the default Rails Date/DateTime helper

    • :calendar - a Javascript popup calendar control

  • :negation_in_filter - turn on/off the negation checkbox in string filters

  • :auto_reload - a boolean value specifying if a change in a filter triggers reloading of the grid. Works with all filter types including the JS calendar, the only exception is the standard Rails date/datetime filters. The default is false. (see AUTO_RELOAD in the configuration file).

The block parameter is an ActiveRecord instance. This block is called for every ActiveRecord shown, and the return value of the block is a string which becomes the contents of one table cell, or an array of two elements where the first element is the cell contents and the second is a hash of HTML attributes to be added for the <td> tag of the current cell.

In case of an array output, please note that if you need to define HTML attributes for all <td>‘s in a column, use td_html_attrs. Also note that if the method returns a hash with a :class or 'class' element, it will not overwrite the class defined in td_html_attrs, or classes added by the grid itself (active_filter and sorted), instead they will be all concatenated: <td class="sorted user_class_for_columns user_class_for_this_specific_cell">

It is up to the developer to make sure that what in rendered in column cells corresponds to sorting and filtering specified by parameters :attribute_name and :model_class.



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/grid_renderer.rb', line 275

def column(opts = {}, &block)
  options = {
    :allow_multiple_selection   => Defaults::ALLOW_MULTIPLE_SELECTION,
    :allow_ordering             => true,
    :attribute_name             => nil,
    :auto_reload                => Defaults::AUTO_RELOAD,
    :boolean_filter_false_label => WiceGridNlMessageProvider.get_message(:BOOLEAN_FILTER_FALSE_LABEL),
    :boolean_filter_true_label  => WiceGridNlMessageProvider.get_message(:BOOLEAN_FILTER_TRUE_LABEL),
    :class                      => nil,
    :column_name                => '',
    :custom_filter              => nil,
    :custom_order               => nil,
    :detach_with_id             => nil,
    :filter_all_label           => Defaults::CUSTOM_FILTER_ALL_LABEL,
    :helper_style               => Defaults::HELPER_STYLE,
    :in_csv                     => true,
    :in_html                    => true,
    :model_class                => nil,
    :negation_in_filter         => Defaults::NEGATION_IN_STRING_FILTERS,
    :no_filter                  => false,
    :table_alias                => nil,
    :td_html_attrs              => {}
  }

  opts.assert_valid_keys(options.keys)
  options.merge!(opts)

  unless options[:model_class].nil?
    options[:model_class] = options[:model_class].constantize if options[:model_class].is_a? String
    raise WiceGridArgumentError.new("Option :model_class can be either a class or a string instance") unless options[:model_class].is_a? Class
  end

  if options[:attribute_name].nil? && options[:model_class]
    raise WiceGridArgumentError.new("Option :model_class is only used together with :attribute_name")
  end

  if options[:attribute_name] && options[:attribute_name].index('.')
    raise WiceGridArgumentError.new("Invalid attribute name #{options[:attribute_name]}. An attribute name must not contain a table name!")
  end

  if options[:class]
    options[:td_html_attrs].add_or_append_class_value!(options[:class])
    options.delete(:class)
  end

  if block.nil?
    if ! options[:attribute_name].blank?
      block = lambda{|obj| obj.send(options[:attribute_name])}
    else
      raise WiceGridArgumentError.new(
        "Missing column block without attribute_name defined. You can only omit the block if attribute_name is present.")
    end
  end

  klass = ViewColumn
  if options[:attribute_name] &&
      col_type_and_table_name = @grid.declare_column(options[:attribute_name], options[:model_class],
        options[:custom_filter],  options[:table_alias])

    db_column, table_name, main_table = col_type_and_table_name
    col_type = db_column.type

    if options[:custom_filter]

      custom_filter = if options[:custom_filter] == :auto
        lambda{ @grid.distinct_values_for_column(db_column) } # Thank God Ruby has higher order functions!!!

      elsif options[:custom_filter].class == Symbol
        lambda{ @grid.distinct_values_for_column_in_resultset([options[:custom_filter]])}

      elsif options[:custom_filter].class == Hash
        options[:custom_filter].keys

        options[:custom_filter].to_a

      elsif options[:custom_filter].class == Array
        if options[:custom_filter].empty?
          []
        elsif options[:custom_filter].all_items_are_of_class(Symbol)
          lambda{ @grid.distinct_values_for_column_in_resultset(options[:custom_filter]) }

        elsif options[:custom_filter].all_items_are_of_class(String) || options[:custom_filter].all_items_are_of_class(Numeric)
          options[:custom_filter].map{|i| [i,i]}

        elsif options[:custom_filter].all_items_are_of_class(Array)
          options[:custom_filter]
        else
          raise WiceGridArgumentError.new(
            ':custom_filter can equal :auto, an array of string and/or numbers (direct values for the dropdown), ' +
            'a homogeneous array of symbols (a sequence of methods to send to AR objects in the result set to ' +
            'retrieve unique values for the dropdown), a Symbol (a shortcut for a one member array of symbols), ' +
            'a hash where keys are labels and values are values for the dropdown option, or an array of two-item arrays, ' +
            'each of which contains the label (first element) and the value (second element) for a dropdown option'
            )
        end
      end

      klass = ViewColumnCustomDropdown
    else
      klass = ViewColumn.handled_type[col_type] || ViewColumn
    end # custom_filter
  end # attribute_name

  vc = klass.new(block, options, @grid, table_name, main_table, custom_filter, @view)

  vc.negation    = options[:negation_in_filter] if vc.respond_to? :negation=

  vc.filter_all_label = options[:filter_all_label] if vc.kind_of?(ViewColumnCustomDropdown)
  if vc.kind_of?(ViewColumnBoolean)
    vc.boolean_filter_true_label = options[:boolean_filter_true_label]
    vc.boolean_filter_false_label = options[:boolean_filter_false_label]
  end
  add_column(vc)
end

#column_labels(filter = nil) ⇒ Object

:nodoc:



60
61
62
 
# File 'lib/grid_renderer.rb', line 60

def column_labels(filter = nil)  #:nodoc:
  filter_columns(filter).collect(&:column_name)
end

#column_link(column, direction, params, extra_parameters = {}) ⇒ Object

:nodoc:



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/grid_renderer.rb', line 488

def column_link(column, direction, params, extra_parameters = {})   #:nodoc:

  column_attribute_name = if column.attribute_name.index('.') or column.main_table
    column.attribute_name
  else
    column.table_alias_or_table_name + '.' + column.attribute_name
  end

  query_params = {@grid.name => {
    @@order_parameter_name => column_attribute_name,
    @@order_direction_parameter_name => direction
  }}

  cleaned_params =  params.deep_clone_yl
  cleaned_params.merge!(extra_parameters)

  cleaned_params.delete(:controller)
  cleaned_params.delete(:action)


  query_params = cleaned_params.rec_merge(query_params)

  '?' + query_params.to_query
end

#config ⇒ Object

:nodoc:



34
35
36
 
# File 'lib/grid_renderer.rb', line 34

def config  #:nodoc:
  @view.config
end

#contains_a_text_input? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


68
69
70
 
# File 'lib/grid_renderer.rb', line 68

def contains_a_text_input?  #:nodoc:
  filter_columns(:in_html).detect(&:contains_a_text_input)
end

#contains_auto_reloading_calendars ⇒ Object

:nodoc:



525
526
527
 
# File 'lib/grid_renderer.rb', line 525

def contains_auto_reloading_calendars #:nodoc:
  contains_auto_reloading_elements(:has_auto_reloading_calendar?)
end

#contains_auto_reloading_inputs ⇒ Object

:nodoc:



513
514
515
 
# File 'lib/grid_renderer.rb', line 513

def contains_auto_reloading_inputs #:nodoc:
  contains_auto_reloading_elements(:has_auto_reloading_input?)
end

#contains_auto_reloading_inputs_with_negation_checkboxes ⇒ Object

:nodoc:



517
518
519
 
# File 'lib/grid_renderer.rb', line 517

def contains_auto_reloading_inputs_with_negation_checkboxes #:nodoc:
  contains_auto_reloading_elements(:auto_reloading_input_with_negation_checkbox?)
end

#contains_auto_reloading_selects ⇒ Object

:nodoc:



521
522
523
 
# File 'lib/grid_renderer.rb', line 521

def contains_auto_reloading_selects #:nodoc:
  contains_auto_reloading_elements(:has_auto_reloading_select?)
end

#contains_range_filters ⇒ Object 



529
530
531
 
# File 'lib/grid_renderer.rb', line 529

def contains_range_filters
  filter_columns(:in_html).detect{|column| column.filter_shown? && column.is_a?(ViewColumnInteger)}
end

#controller ⇒ Object

:nodoc:



38
39
40
 
# File 'lib/grid_renderer.rb', line 38

def controller  #:nodoc:
  @view.controller
end

#csv_export_icon ⇒ Object

:nodoc:



98
99
100
101
102
103
104
105
106
 
# File 'lib/grid_renderer.rb', line 98

def csv_export_icon #:nodoc:
  tooltip = WiceGridNlMessageProvider.get_message(:CSV_EXPORT_TOOLTIP)
  @csv_export_icon_present = true
  image_tag(Defaults::CSV_EXPORT_ICON,
    :title => tooltip,
    :class => 'clickable export_to_csv_button',
    :alt   => tooltip
  )
end

#each_column(filter = nil) ⇒ Object Also known as: each

:nodoc:



64
65
66
 
# File 'lib/grid_renderer.rb', line 64

def each_column(filter = nil)  #:nodoc:
  filter_columns(filter).each{|col| yield col}
end

#each_column_aware_of_one_last_one(filter = nil) {|cols.last, true| ... } ⇒ Object

:nodoc:

Yields:

  • (cols.last, true) 


72
73
74
75
76
 
# File 'lib/grid_renderer.rb', line 72

def each_column_aware_of_one_last_one(filter = nil)  #:nodoc:
  cols = filter_columns(filter)
  cols[0..-2].each{|col| yield col, false}
  yield cols.last, true
end

#each_column_label(filter = nil) ⇒ Object

:nodoc:



56
57
58
 
# File 'lib/grid_renderer.rb', line 56

def each_column_label(filter = nil)  #:nodoc:
  filter_columns(filter).each{|col| yield col.column_name}
end

#each_column_with_attribute ⇒ Object

:nodoc:



91
92
93
 
# File 'lib/grid_renderer.rb', line 91

def each_column_with_attribute  #:nodoc:
  @columns.select(&:attribute_name).each{|col| yield col}
end

#element_to_focus ⇒ Object

:nodoc:



131
132
133
 
# File 'lib/grid_renderer.rb', line 131

def element_to_focus  #:nodoc:
  grid.status['foc']
end

#find_one_for(filter) ⇒ Object

:nodoc:



86
87
88
 
# File 'lib/grid_renderer.rb', line 86

def find_one_for(filter)  #:nodoc:
  filter_columns(filter).find{|col| yield col}
end

#get_row_attributes(ar_object) ⇒ Object

:nodoc:



432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/grid_renderer.rb', line 432

def get_row_attributes(ar_object) #:nodoc:
  if @row_attributes_handler
    row_attributes = @row_attributes_handler.call(ar_object)
    row_attributes = {} if row_attributes.blank?
    unless row_attributes.is_a?(Hash)
      raise WiceGridArgumentError.new("row_attributes block must return a hash containing HTML attributes. The returned value is #{row_attributes.inspect}")
    end
    row_attributes
  else
    {}
  end
end

#last_column_for_html ⇒ Object

:nodoc:



78
79
80
 
# File 'lib/grid_renderer.rb', line 78

def last_column_for_html  #:nodoc:
  filter_columns(:in_html).last
end

#last_row(&block) ⇒ Object

Can be used to add HTML code (calculation results, for example) after all rows. Nothing is added if the block return false or nil.



413
414
415
 
# File 'lib/grid_renderer.rb', line 413

def last_row(&block)
  @last_row_handler = block
end

#link_for_export(controller, format, extra_parameters = {}) ⇒ Object

:nodoc:



476
477
478
479
480
481
482
483
484
485
 
# File 'lib/grid_renderer.rb', line 476

def link_for_export(controller, format, extra_parameters = {})   #:nodoc:
  new_params = controller.params.deep_clone_yl
  new_params.merge!(extra_parameters)

  new_params[@grid.name] = {} unless new_params[@grid.name]
  new_params[@grid.name][:export] = format

  new_params[:only_path] = false
  controller.url_for(new_params)
end

#no_filter_needed? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


446
447
448
 
# File 'lib/grid_renderer.rb', line 446

def no_filter_needed?   #:nodoc:
  not @columns.inject(false){|a,b| a || b.filter_shown? }
end

#no_filter_needed_in_main_table? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


450
451
452
 
# File 'lib/grid_renderer.rb', line 450

def no_filter_needed_in_main_table?   #:nodoc:
  not @columns.inject(false){|a,b| a || b.filter_shown_in_main_table? }
end

#number_of_columns(filter = nil) ⇒ Object

:nodoc:



52
53
54
 
# File 'lib/grid_renderer.rb', line 52

def number_of_columns(filter = nil)  #:nodoc:
  filter_columns(filter).size
end

#pagination_panel(no_rightmost_column, hide_csv_button) ⇒ Object

:nodoc:



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/grid_renderer.rb', line 108

def pagination_panel(no_rightmost_column, hide_csv_button)  #:nodoc:
  panel = yield

  render_csv_button = @grid.export_to_csv_enabled && ! hide_csv_button

  number_of_columns = self.number_of_columns(:in_html)
  number_of_columns -= 1 if no_rightmost_column

  if panel.nil?
    if render_csv_button
      "<tr><td colspan=\"#{number_of_columns}\"></td><td>#{csv_export_icon}</td></tr>"
    else
      ''
    end
  else
    if render_csv_button
      "<tr><td colspan=\"#{number_of_columns}\">#{panel}</td><td>#{csv_export_icon}</td></tr>"
    else
      "<tr><td colspan=\"#{number_of_columns + 1}\">#{panel}</td></tr>"
    end
  end
end

#row_attributes(&block) ⇒ Object

Optional method inside the grid block, to which every ActiveRecord instance is injected, just like column. Unlike column, it returns a hash which will be used as HTML attributes for the row with the given ActiveRecord instance.

Note that if the method returns a hash with a :class or 'class' element, it will not overwrite classes even and odd, instead they will be concatenated: <tr class="even highlighted_row_class_name">



395
396
397
 
# File 'lib/grid_renderer.rb', line 395

def row_attributes(&block)
  @row_attributes_handler = block
end

#select_for(filter) ⇒ Object

:nodoc:



82
83
84
 
# File 'lib/grid_renderer.rb', line 82

def select_for(filter)  #:nodoc:
  filter_columns(filter).select{|col| yield col}
end